Merge #328

328: Prevent quoted doc strings from generating extra blanks at the beginning r=adamgreig a=therealprof

Using `/// something` in a quote! block generates
`#[doc = r" something"]`
need to use `///something` to get the more appropriate
`#[doc = r"something"]`
instead

Signed-off-by: Daniel Egger <[email protected]>

Co-authored-by: Daniel Egger <[email protected]>

Author: bors[bot]

src/generate/device.rs

@@ -90,7 +90,7 @@ pub fn render(
         let bits = util::unsuffixed(u64::from(cpu.nvic_priority_bits));
 
         out.push(quote! {
-            /// Number available in the NVIC for configuring priority
+            ///Number available in the NVIC for configuring priority
             pub const NVIC_PRIO_BITS: u8 = #bits;
         });
 
@@ -173,7 +173,7 @@ pub fn render(
     }
     .map(|krate| {
         quote! {
-            /// Returns all the peripherals *once*
+            ///Returns all the peripherals *once*
             #[inline]
             pub fn take() -> Option<Self> {
                 #krate::interrupt::free(|_| {
@@ -194,7 +194,7 @@ pub fn render(
         #[no_mangle]
         static mut DEVICE_PERIPHERALS: bool = false;
 
-        /// All the peripherals
+        ///All the peripherals
         #[allow(non_snake_case)]
         pub struct Peripherals {
             #(#fields,)*
@@ -203,7 +203,7 @@ pub fn render(
         impl Peripherals {
             #take
 
-            /// Unchecked version of `Peripherals::take`
+            ///Unchecked version of `Peripherals::take`
             pub unsafe fn steal() -> Self {
                 DEVICE_PERIPHERALS = true;
 

src/generate/interrupt.rs

@@ -153,7 +153,7 @@ pub fn render(
     }
 
     let interrupt_enum = quote! {
-        /// Enumeration of all the interrupts
+        ///Enumeration of all the interrupts
         #[derive(Copy, Clone, Debug)]
         pub enum Interrupt {
             #(#variants)*

src/generate/peripheral.rs

@@ -53,7 +53,7 @@ pub fn render(
         unsafe impl Send for #name_pc {}
 
         impl #name_pc {
-            /// Returns a pointer to the register block
+            ///Returns a pointer to the register block
             #[inline(always)]
             pub const fn ptr() -> *const #base::RegisterBlock {
                 #address as *const _
@@ -540,7 +540,7 @@ fn register_or_cluster_block(
     };
 
     Ok(quote! {
-        /// Register block
+        ///Register block
         #[repr(C)]
         pub struct #name {
             #fields
@@ -747,7 +747,7 @@ fn cluster_block(
     Ok(quote! {
         #reg_block
 
-        /// Register block
+        ///Register block
         #[doc = #description]
         pub mod #name_sc {
             #(#mod_items)*

src/generate/register.rs

@@ -44,7 +44,7 @@ pub fn render(
 
     if access == Access::ReadWrite || access == Access::ReadWriteOnce {
         reg_impl_items.push(quote! {
-            /// Modifies the contents of the register
+            ///Modifies the contents of the register
             #[inline(always)]
             pub fn modify<F>(&self, f: F)
             where
@@ -58,22 +58,22 @@ pub fn render(
 
     if can_read {
         reg_impl_items.push(quote! {
-            /// Reads the contents of the register
+            ///Reads the contents of the register
             #[inline(always)]
             pub fn read(&self) -> R {
                 R { bits: self.register.get() }
             }
         });
 
         mod_items.push(quote! {
-            /// Value read from the register
+            ///Value read from the register
             pub struct R {
                 bits: #rty,
             }
         });
 
         r_impl_items.push(quote! {
-            /// Value of the register as raw bits
+            ///Value of the register as raw bits
             #[inline(always)]
             pub fn bits(&self) -> #rty {
                 self.bits
@@ -83,7 +83,7 @@ pub fn render(
 
     if can_write {
         reg_impl_items.push(quote! {
-            /// Writes to the register
+            ///Writes to the register
             #[inline(always)]
             pub fn write<F>(&self, f: F)
             where
@@ -94,7 +94,7 @@ pub fn render(
         });
 
         mod_items.push(quote! {
-            /// Value to write to the register
+            ///Value to write to the register
             pub struct W {
                 bits: #rty,
             }
@@ -107,20 +107,20 @@ pub fn render(
             .ok_or_else(|| format!("Register {} has no reset value", register.name))?;
 
         reg_impl_items.push(quote! {
-            /// Reset value of the register
+            ///Reset value of the register
             #[inline(always)]
             pub const fn reset_value() -> #rty {
                 #rv
             }
-            /// Writes the reset value to the register
+            ///Writes the reset value to the register
             #[inline(always)]
             pub fn reset(&self) {
                 self.register.set(Self::reset_value())
             }
         });
 
         w_impl_items.push(quote! {
-            /// Writes raw bits to the register
+            ///Writes raw bits to the register
             #[inline(always)]
             pub #unsafety fn bits(&mut self, bits: #rty) -> &mut Self {
                 self.bits = bits;
@@ -390,7 +390,7 @@ pub fn fields(
                         .collect::<Vec<_>>();
                     if has_reserved_variant {
                         vars.push(quote! {
-                            /// Reserved
+                            ///Reserved
                             _Reserved(#fty)
                         });
                     }
@@ -423,13 +423,13 @@ pub fn fields(
 
                     if f.width == 1 {
                         enum_items.push(quote! {
-                            /// Returns `true` if the bit is clear (0)
+                            ///Returns `true` if the bit is clear (0)
                             #[inline(always)]
                             pub fn bit_is_clear(&self) -> bool {
                                 !self.#bits()
                             }
 
-                            /// Returns `true` if the bit is set (1)
+                            ///Returns `true` if the bit is set (1)
                             #[inline(always)]
                             pub fn bit_is_set(&self) -> bool {
                                 self.#bits()
@@ -438,7 +438,7 @@ pub fn fields(
                     }
 
                     enum_items.push(quote! {
-                        /// Value of the field as raw bits
+                        ///Value of the field as raw bits
                         #[inline(always)]
                         pub fn #bits(&self) -> #fty {
                             match *self {
@@ -521,7 +521,7 @@ pub fn fields(
 
                 let mut pc_r_impl_items = vec![
                     quote! {
-                        /// Value of the field as raw bits
+                        ///Value of the field as raw bits
                         #[inline(always)]
                         pub fn #bits(&self) -> #fty {
                             self.bits
@@ -531,13 +531,13 @@ pub fn fields(
 
                 if f.width == 1 {
                     pc_r_impl_items.push(quote! {
-                        /// Returns `true` if the bit is clear (0)
+                        ///Returns `true` if the bit is clear (0)
                         #[inline(always)]
                         pub fn bit_is_clear(&self) -> bool {
                             !self.#bits()
                         }
 
-                        /// Returns `true` if the bit is set (1)
+                        ///Returns `true` if the bit is set (1)
                         #[inline(always)]
                         pub fn bit_is_set(&self) -> bool {
                             self.#bits()
@@ -546,7 +546,7 @@ pub fn fields(
                 }
 
                 mod_items.push(quote! {
-                    /// Value of the field
+                    ///Value of the field
                     pub struct #pc_r {
                         bits: #fty,
                     }
@@ -704,7 +704,7 @@ pub fn fields(
                 }
 
                 proxy_items.push(quote! {
-                    /// Writes `variant` to the field
+                    ///Writes `variant` to the field
                     #[inline(always)]
                     pub fn variant(self, variant: #pc_w) -> &'a mut W {
                         #unsafety {
@@ -740,20 +740,20 @@ pub fn fields(
 
             if width == 1 {
                 proxy_items.push(quote! {
-                    /// Sets the field bit
+                    ///Sets the field bit
                     pub #unsafety fn set_bit(self) -> &'a mut W {
                         self.bit(true)
                     }
 
-                    /// Clears the field bit
+                    ///Clears the field bit
                     pub #unsafety fn clear_bit(self) -> &'a mut W {
                         self.bit(false)
                     }
                 });
             }
 
             proxy_items.push(quote! {
-                /// Writes raw bits to the field
+                ///Writes raw bits to the field
                 #[inline(always)]
                 pub #unsafety fn #bits(self, value: #fty) -> &'a mut W {
                     self.w.bits &= !(#mask << #offset);
@@ -764,7 +764,7 @@ pub fn fields(
 
             let _pc_w = &f._pc_w;
             mod_items.push(quote! {
-                /// Proxy
+                ///Proxy
                 pub struct #_pc_w<'a> {
                     w: &'a mut W,
                 }