Clean up comments.

Author: jonathanpallant

src/fat/mod.rs

@@ -1,4 +1,4 @@
-//! embedded-sdmmc-rs - FAT16/FAT32 file system implementation
+//! FAT16/FAT32 file system implementation
 //!
 //! Implements the File Allocation Table file system. Supports FAT16 and FAT32 volumes.
 

src/fat/volume.rs

@@ -37,7 +37,7 @@ impl core::fmt::Debug for VolumeName {
     }
 }
 
-/// Identifies a FAT16 Volume on the disk.
+/// Identifies a FAT16 or FAT32 Volume on the disk.
 #[cfg_attr(feature = "defmt-log", derive(defmt::Format))]
 #[derive(PartialEq, Eq, Debug)]
 pub struct FatVolume {
@@ -76,7 +76,9 @@ impl FatVolume {
         T: TimeSource,
     {
         match &self.fat_specific_info {
-            FatSpecificInfo::Fat16(_) => {}
+            FatSpecificInfo::Fat16(_) => {
+                // FAT16 volumes don't have an info sector
+            }
             FatSpecificInfo::Fat32(fat32_info) => {
                 if self.free_clusters_count.is_none() && self.next_free_cluster.is_none() {
                     return Ok(());

src/filesystem/mod.rs

@@ -1,4 +1,4 @@
-//! embedded-sdmmc-rs - Generic File System structures
+//! Generic File System structures
 //!
 //! Implements generic file system components. These should be applicable to
 //! most (if not all) supported filesystems.

src/lib.rs

@@ -234,8 +234,9 @@ pub enum VolumeType {
 }
 
 /// A `VolumeIdx` is a number which identifies a volume (or partition) on a
-/// disk. `VolumeIdx(0)` is the first primary partition on an MBR partitioned
 /// disk.
+///
+/// `VolumeIdx(0)` is the first primary partition on an MBR partitioned disk.
 #[cfg_attr(feature = "defmt-log", derive(defmt::Format))]
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 pub struct VolumeIdx(pub usize);