alias_doc

Author: burrbull

src/generate/register.rs

@@ -81,8 +81,24 @@ pub fn render(
         } else {
             return Err(anyhow!("Incorrect access of register {}", register.name));
         };
-        let alias_doc =
-            format!("{name} ({accs}) register accessor: an alias for `Reg<{regspec_ident}>`");
+
+        let mut alias_doc = format!(
+            "{name} ({accs}) register accessor: {description}\n\n{}",
+            api_docs(
+                access.can_read(),
+                access.can_write(),
+                register.properties.reset_value.is_some(),
+                &name_snake_case,
+                false,
+                register.read_action,
+            )?
+        );
+        if name_snake_case != "cfg" {
+            alias_doc += format!(
+                "\n\nFor information about available fields see [`{name_snake_case}`] module"
+            )
+            .as_str();
+        }
         let mut out = TokenStream::new();
         out.extend(quote! {
             #[doc = #alias_doc]
@@ -112,6 +128,7 @@ fn api_docs(
     can_write: bool,
     can_reset: bool,
     module: &Ident,
+    inmodule: bool,
     read_action: Option<ReadAction>,
 ) -> Result<String, std::fmt::Error> {
     fn method(s: &str) -> String {
@@ -123,8 +140,9 @@ fn api_docs(
     if can_read {
         write!(
             doc,
-            "You can {} this register and get [`{module}::R`](R).",
-            method("read")
+            "You can {} this register and get [`{module}::R`]{}.",
+            method("read"),
+            if inmodule { "(R)" } else { "" },
         )?;
 
         if let Some(action) = read_action {
@@ -148,21 +166,18 @@ fn api_docs(
         methods.push("write_with_zero");
         writeln!(
             doc,
-            "You can {} this register using [`{module}::W`](W).<br>",
+            "You can {} this register using [`{module}::W`]{}.<br>",
             methods
                 .iter()
                 .map(|m| method(m))
                 .collect::<Vec<_>>()
-                .join(", ")
+                .join(", "),
+            if inmodule { "(W)" } else { "" },
         )?;
     }
 
     if can_read && can_write {
-        writeln!(
-            doc,
-            "You can also {} this register using [`{module}::R`](R) and [`{module}::W`](W).<br>",
-            method("modify")
-        )?;
+        writeln!(doc, "You can also {} this register.<br>", method("modify"),)?;
     }
 
     doc.push_str("See [API](https://docs.rs/svd2rust/#read--modify--write-api).");
@@ -370,7 +385,8 @@ pub fn render_register_mod(
             can_write,
             can_reset,
             &name_snake_case,
-            register.read_action
+            true,
+            register.read_action,
         )?
     );