From 74ea262f654633f2431018d03ce45899fb9cd6d2 Mon Sep 17 00:00:00 2001
From: "Jonathan Pallant (42 Technology)" <jonathan.pallant@42technology.com>
Date: Mon, 11 Oct 2021 16:40:23 +0100
Subject: [PATCH] Cleaning up the comment summaries.

---
 rp2040-hal/src/rom_data.rs | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

diff --git a/rp2040-hal/src/rom_data.rs b/rp2040-hal/src/rom_data.rs
index 4dd6111..8d63280 100644
--- a/rp2040-hal/src/rom_data.rs
+++ b/rp2040-hal/src/rom_data.rs
@@ -115,8 +115,10 @@ rom_funcs_unsafe! {
     /// Sets n bytes start at ptr to the value c and returns ptr
     b"MS" memset(ptr: *mut u8, c: u8, n: u8) -> *mut u8;
 
-    /// Sets n bytes start at ptr to the value c and returns ptr. Note this is a slightly more
-    /// efficient variant of _memset that may only be used if ptr is word aligned.
+    /// Sets n bytes start at ptr to the value c and returns ptr.
+    ///
+    /// Note this is a slightly more efficient variant of _memset that may only
+    /// be used if ptr is word aligned.
     b"M4" memset4(ptr: *mut u32, c: u8, n: u32) -> *mut u32;
 
     /// Copies n bytes starting at src to dest and returns dest. The results are undefined if the
@@ -124,7 +126,9 @@ rom_funcs_unsafe! {
     b"MC" memcpy(dest: *mut u8, src: *mut u8, n: u32) -> u8;
 
     /// Copies n bytes starting at src to dest and returns dest. The results are undefined if the
-    /// regions overlap. Note this is a slightly more efficient variant of _memcpy that may only be
+    /// regions overlap.
+    /// 
+    /// Note this is a slightly more efficient variant of _memcpy that may only be
     /// used if dest and src are word aligned.
     b"C4" memcpy44(dest: *mut u32, src: *mut u32, n: u32) -> *mut u8;
 
@@ -132,6 +136,7 @@ rom_funcs_unsafe! {
     b"IF" connect_internal_flash() -> ();
 
     /// First set up the SSI for serial-mode operations, then issue the fixed XIP exit sequence.
+    /// 
     /// Note that the bootrom code uses the IO forcing logic to drive the CS pin, which must be
     /// cleared before returning the SSI to XIP mode (e.g. by a call to _flash_flush_cache). This
     /// function configures the SSI with a fixed SCK clock divisor of /6.
@@ -188,9 +193,11 @@ pub fn git_revision() -> u32 {
     unsafe { *s }
 }
 
-/// The start address of the floating point library code and data. This and fplib_end along with the individual
-/// function pointers in soft_float_table can be used to copy the floating point implementation into RAM if
-/// desired.
+/// The start address of the floating point library code and data.
+///
+/// This and fplib_end along with the individual function pointers in
+/// soft_float_table can be used to copy the floating point implementation into
+/// RAM if desired.
 pub fn fplib_start() -> *const u8 {
     rom_table_lookup(DATA_TABLE, *b"FS")
 }