docs

Author: burrbull

src/generate/register.rs

@@ -59,9 +59,11 @@ pub fn render(
             .ok_or_else(|| format!("Register {} has no reset value", register.name))?;
 
         let desc = format!("Writer for register {}", register.name);
+        let doc = format!("Register {} `reset()`'s with value {}", register.name, &rv);
         mod_items.push(quote! {
             #[doc = #desc]
             pub type W = crate::W<#rty, super::#name_pc>;
+            #[doc = #doc]
             impl crate::ResetValue<#rty> for super::#name_pc {
                 #[inline(always)]
                 fn reset_value() -> #rty { #rv }
@@ -130,22 +132,33 @@ pub fn render(
     }
 
     let mut out = vec![];
+    let doc = if name_sc != "cfg" {
+        format!("For information about avaliable fields see [{0}]({0}) module", &name_sc)
+    } else {
+        "".to_string()
+    };
     out.push(quote! {
         #[doc = #description]
+        ///
+        #[doc = #doc]
         pub type #name_pc = crate::Reg<#rty, #_name_pc>;
 
         #[allow(missing_docs)]
         #[doc(hidden)]
         pub struct #_name_pc;
     });
 
+    let doc = format!("`read()` method returns [{0}::R]({0}::R) reader structure", &name_sc);
     if can_read {
         out.push(quote! {
+            #[doc = #doc]
             impl crate::Readable for #name_pc {}
         });
     }
+    let doc = format!("`write(|w| ..)` method takes [{0}::W]({0}::W) writer structure", &name_sc);
     if can_write {
         out.push(quote! {
+            #[doc = #doc]
             impl crate::Writable for #name_pc {}
         });
     }