Skip to content

Commit 95df37e

Browse files
jonathanpallanteldruin
authored andcommitted
Clean up mod-level comments.
1 parent 14b62bb commit 95df37e

File tree

5 files changed

+8
-5
lines changed

5 files changed

+8
-5
lines changed

src/blockdevice.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
//! embedded-sdmmc-rs - Block Device support
1+
//! Block Device support
22
//!
3-
//! Generic code for handling block devices.
3+
//! Generic code for handling block devices, such as types for identifying
4+
//! a particular block on a block device by its index.
45
56
/// Represents a standard 512 byte block (also known as a sector). IBM PC
67
/// formatted 5.25" and 3.5" floppy disks, SD/MMC cards up to 1 GiB in size

src/sdmmc.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! embedded-sdmmc-rs - SDMMC Protocol
1+
//! The SD/MMC Protocol
22
//!
33
//! Implements the SD/MMC protocol on some generic SPI interface.
44
//!

src/sdmmc_proto.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! embedded-sdmmc-rs - Constants from the SD Specifications
1+
//! Constants from the SD Specifications
22
//!
33
//! Based on SdFat, under the following terms:
44
//!

src/structure.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! embedded-sdmmc-rs - Useful macros for parsing SD/MMC structures.
1+
//! Useful macros for parsing SD/MMC structures.
22
33
macro_rules! access_field {
44
($self:expr, $offset:expr, $start_bit:expr, 1) => {

src/volume_mgr.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! The Volume Manager handles partitions and open files on a block device.
2+
13
use byteorder::{ByteOrder, LittleEndian};
24
use core::convert::TryFrom;
35

0 commit comments

Comments
 (0)