itm: improve unlock documentation

tmplt · tmplt · commit 508292c22780 · 2022-01-04T13:53:29.000+01:00
diff --git a/src/peripheral/itm.rs b/src/peripheral/itm.rs
@@ -175,7 +175,7 @@ pub struct ITMSettings {
 }
 
 impl ITM {
-    /// Removes the software lock on the ITM.
+    /// Removes the software lock on the ITM. Must be called before any other [ITM] functions.
     #[inline]
     pub fn unlock(&mut self) {
         // NOTE(unsafe) atomic write to a stateless, write-only register

Original file line number	Diff line number	Diff line change
`@@ -175,7 +175,7 @@ pub struct ITMSettings {`
`175`	`175`	`}`
`176`	`176`
`177`	`177`	`impl ITM {`
`178`		`- /// Removes the software lock on the ITM.`
	`178`	`+ /// Removes the software lock on the ITM. Must be called before any other [ITM] functions.`
`179`	`179`	`#[inline]`
`180`	`180`	`pub fn unlock(&mut self) {`
`181`	`181`	`// NOTE(unsafe) atomic write to a stateless, write-only register`