UART: Documentation tweaks

Co-authored-by: Filip Demski (Glamhoth) <Glamhoth@users.noreply.github.com>
n7space · Oct 19, 2023 · 2de0018 · 2de0018
1 parent 71f9853
commit 2de0018
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/arch/cortex-m/samv71-hal/src/uart/reader.rs b/arch/cortex-m/samv71-hal/src/uart/reader.rs
@@ -84,6 +84,7 @@ impl<Instance: UARTMetadata> Reader<Instance> {
     }
 
     /// Resets UART status by clearing status flags.
+    ///
     /// **This function should usually be called immediately after reading the status.**
     #[inline(always)]
     pub fn reset_status(&mut self) {

diff --git a/arch/cortex-m/samv71-hal/src/uart/writer.rs b/arch/cortex-m/samv71-hal/src/uart/writer.rs
@@ -30,6 +30,7 @@ pub struct Writer<Instance: UARTMetadata> {
 
 impl<Instance: UARTMetadata> Writer<Instance> {
     /// Transmits a single byte.
+    ///
     /// Waits for UART TX register to be empty.
     /// Does not wait until transmission is completed, use [`Writer::flush`] if you want to make sure
     /// of that.