safety

burrbull · burrbull · commit be37b647a740 · 2023-08-09T14:46:58.000+03:00
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 }
                     }

Original file line number	Diff line number	Diff line change
`@@ -93,6 +93,10 @@ pub fn render(p_original: &Peripheral, index: &Index, config: &Config) -> Result`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`///Steal an instance of this peripheral`
	`96`	`+ ///`
	`97`	`+ ///# Safety`
	`98`	`+ ///`
	`99`	+ ///Make sure that [`Peripherals::steal`] is already called
`96`	`100`	`pub unsafe fn steal() -> Self {`
`97`	`101`	`Self { _marker: PhantomData }`
`98`	`102`	`}`
`@@ -157,6 +161,10 @@ pub fn render(p_original: &Peripheral, index: &Index, config: &Config) -> Result`
`157`	`161`	`}`
`158`	`162`
`159`	`163`	`///Steal an instance of this peripheral`
	`164`	`+ ///`
	`165`	`+ ///# Safety`
	`166`	`+ ///`
	`167`	+ ///Make sure that [`Peripherals::steal`] is already called
`160`	`168`	`pub unsafe fn steal() -> Self {`
`161`	`169`	`Self { _marker: PhantomData }`
`162`	`170`	`}`