docs reset_value

Author: burrbull

src/generate/generic.rs

@@ -24,9 +24,11 @@ pub fn render() -> Result<Vec<Tokens>> {
         ///
         ///This value is initial value for `write` method.
         ///It can be also directly writed to register by `reset` method.
-        pub trait ResetValue<U> {
+        pub trait ResetValue {
+            ///Register size
+            type Size;
             ///Reset value of the register
-            fn reset_value() -> U;
+            fn reset_value() -> Self::Size;
         }
 
         ///Converting enumerated values to bits
@@ -61,7 +63,7 @@ pub fn render() -> Result<Vec<Tokens>> {
 
         impl<U, REG> Reg<U, REG>
         where
-            Self: ResetValue<U> + Writable,
+            Self: ResetValue<Size=U> + Writable,
             U: Copy,
         {
             ///Writes the reset value to `Writable` register
@@ -75,7 +77,7 @@ pub fn render() -> Result<Vec<Tokens>> {
     generic_items.push(quote! {
         impl<U, REG> Reg<U, REG>
         where
-            Self: ResetValue<U> + Writable,
+            Self: ResetValue<Size=U> + Writable,
             U: Copy
         {
             ///Writes bits to `Writable` register

src/generate/register.rs

@@ -50,7 +50,7 @@ pub fn render(
             #[doc = #desc]
             pub type R = crate::R<#rty, super::#name_pc>;
         });
-        methods.push("`read`");
+        methods.push("read");
     }
 
     if can_write {
@@ -66,18 +66,19 @@ pub fn render(
             #[doc = #desc]
             pub type W = crate::W<#rty, super::#name_pc>;
             #[doc = #doc]
-            impl crate::ResetValue<#rty> for super::#name_pc {
+            impl crate::ResetValue for super::#name_pc {
+                type Size = #rty;
                 #[inline(always)]
-                fn reset_value() -> #rty { #rv }
+                fn reset_value() -> Self::Size { #rv }
             }
         });
-        methods.push("`reset`");
-        methods.push("`write`");
-        methods.push("`write_with_zero`");
+        methods.push("reset");
+        methods.push("write");
+        methods.push("write_with_zero");
     }
 
     if can_read && can_write {
-        methods.push("`modify`");
+        methods.push("modify");
     }
 
     if let Some(cur_fields) = register.fields.as_ref() {
@@ -141,6 +142,7 @@ pub fn render(
     }
 
     let mut out = vec![];
+    let methods = methods.iter().map(|s| format!("[`{0}`](crate::generic::Reg::{0})", s)).collect::<Vec<_>>();
     let mut doc = format!("{}\n\nThis register you can {}. See [API](https://docs.rs/svd2rust/#read--modify--write-api).",
                         &description, methods.join(", "));