add register reader/writer links

Author: burrbull

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 
 - Fix when `atomics` features is generated but not enabled
+- move hidden structs into module, add register reader/writer links into `SPEC` docs (#736)
 - removed register writer & reader wrappers, generic `REG` in field writers (#731)
 - Updated syn to version 2 (#732)
 - Let readable field fetch doc from svd description (#734)

src/generate/register.rs

@@ -8,6 +8,7 @@ use proc_macro2::{Ident, Punct, Spacing, Span, TokenStream};
 use quote::{quote, ToTokens};
 use std::borrow::Cow;
 use std::collections::HashSet;
+use std::fmt::Write;
 use svd_parser::expand::{
     derive_enumerated_values, derive_field, BlockPath, EnumPath, FieldPath, Index, RegisterPath,
 };
@@ -138,19 +139,28 @@ pub fn render_register_mod(
     );
 
     let mut mod_items = TokenStream::new();
-    let mut methods = vec![];
 
     let can_read = access.can_read();
     let can_write = access.can_write();
     let can_reset = properties.reset_value.is_some();
 
+    let mut doc = format!("{description}\n");
+
+    fn method(s: &str) -> String {
+        format!("[`{s}`](crate::generic::Reg::{s})")
+    }
+
     if can_read {
         let desc = format!("Register `{}` reader", register.name);
         mod_items.extend(quote! {
             #[doc = #desc]
             pub type R = crate::R<#regspec_ident>;
         });
-        methods.push("read");
+        write!(
+            doc,
+            "\nThis register you can {} with [`R`].",
+            method("read")
+        )?;
     }
 
     if can_write {
@@ -159,17 +169,29 @@ pub fn render_register_mod(
             #[doc = #desc]
             pub type W = crate::W<#regspec_ident>;
         });
+        let mut methods = Vec::new();
         methods.push("write_with_zero");
         if can_reset {
             methods.push("reset");
             methods.push("write");
         }
+        write!(
+            doc,
+            "\nThis register you can {} with [`W`].",
+            methods
+                .iter()
+                .map(|m| method(m))
+                .collect::<Vec<_>>()
+                .join(", ")
+        )?;
     }
 
     if can_read && can_write {
-        methods.push("modify");
+        write!(doc, "\nAnd {} with [`R`] and [`W`].", method("modify"))?;
     }
 
+    doc.push_str("\nSee [API](https://docs.rs/svd2rust/#read--modify--write-api).");
+
     let mut r_impl_items = TokenStream::new();
     let mut r_debug_impl = TokenStream::new();
     let mut w_impl_items = TokenStream::new();
@@ -310,12 +332,6 @@ pub fn render_register_mod(
         close.to_tokens(&mut mod_items);
     }
 
-    let methods = methods
-        .iter()
-        .map(|s| format!("[`{s}`](crate::generic::Reg::{s})"))
-        .collect::<Vec<_>>();
-    let mut doc = format!("{description}\n\nThis register you can {}. See [API](https://docs.rs/svd2rust/#read--modify--write-api).", methods.join(", "));
-
     if name_snake_case != "cfg" {
         doc += format!(
             "\n\nFor information about available fields see [{name_snake_case}](index.html) module"