safety

rust-embedded · Aug 9, 2023 · be37b64 · be37b64
1 parent a45ffcc
commit be37b64
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/generate/peripheral.rs b/src/generate/peripheral.rs
@@ -93,6 +93,10 @@ pub fn render(p_original: &Peripheral, index: &Index, config: &Config) -> Result
                         }
 
                         ///Steal an instance of this peripheral
+                        ///
+                        ///# Safety
+                        ///
+                        ///Make sure that [`Peripherals::steal`] is already called
                         pub unsafe fn steal() -> Self {
                             Self { _marker: PhantomData }
                         }
@@ -157,6 +161,10 @@ pub fn render(p_original: &Peripheral, index: &Index, config: &Config) -> Result
                     }
 
                     ///Steal an instance of this peripheral
+                        ///
+                        ///# Safety
+                        ///
+                        ///Make sure that [`Peripherals::steal`] is already called
                     pub unsafe fn steal() -> Self {
                         Self { _marker: PhantomData }
                     }