From e5e1d8f00038d9e416e41c5c4c06d0adfc8b364d Mon Sep 17 00:00:00 2001 From: Jennifer Averett Date: Fri, 21 Dec 2012 11:56:26 -0600 Subject: libblock: Doxygen Enhancement Task #1 corrections --- cpukit/libblock/include/rtems/bdpart.h | 5 ++--- cpukit/libblock/include/rtems/blkdev.h | 6 +++--- 2 files changed, 5 insertions(+), 6 deletions(-) (limited to 'cpukit/libblock') diff --git a/cpukit/libblock/include/rtems/bdpart.h b/cpukit/libblock/include/rtems/bdpart.h index c45e109ccf..25624f9c9b 100644 --- a/cpukit/libblock/include/rtems/bdpart.h +++ b/cpukit/libblock/include/rtems/bdpart.h @@ -33,12 +33,11 @@ extern "C" { #endif /* __cplusplus */ /** - * @brief Manage Partitions of a Disk Device * @defgroup rtems_bdpart Block Device Partition Management * * @ingroup rtems_libblock * - * This module provides functions to manage partitions of a disk device. + * @brief This module provides functions to manage partitions of a disk device. * * A @ref rtems_disk "disk" is a set of blocks which are identified by a * consecutive set of non-negative integers starting at zero. There are also @@ -335,7 +334,7 @@ rtems_status_code rtems_bdpart_unmount( ); /** - * @brief Prints the Partition Table @a Partitions with @a Count Partitions + * @brief The Partition Table @a Partitions with @a Count Partitions is printed. * * Prints the partition table @a partitions with @a count partitions to * standard output. diff --git a/cpukit/libblock/include/rtems/blkdev.h b/cpukit/libblock/include/rtems/blkdev.h index e7571ddb39..f29a34987f 100644 --- a/cpukit/libblock/include/rtems/blkdev.h +++ b/cpukit/libblock/include/rtems/blkdev.h @@ -276,7 +276,7 @@ static inline int rtems_disk_fd_reset_device_stats(int fd) /** @} */ /** - * @brief Common IO Control Primitive + * @brief Common IO control primitive. * * Use this in all block devices to handle the common set of IO control * requests. @@ -344,7 +344,7 @@ rtems_status_code rtems_blkdev_create_partition( ); /** - * @brief Prints the Block Device Statistics + * @brief Prints the block device statistics. */ void rtems_blkdev_print_stats( const rtems_blkdev_stats *stats, @@ -353,7 +353,7 @@ void rtems_blkdev_print_stats( ); /** - * @brief Block Device Statistics Command + * @brief Block device statistics command. */ void rtems_blkstats( FILE *output, -- cgit v1.2.3