[1/1] cpukit/libblock Doxygen Enhancement Task #1

[Sebastian Huber]

Hello Cynthia,

On 12/21/2012 06:04 AM, Cynthia Rempel wrote:
> diff --git a/cpukit/libblock/include/rtems/bdpart.h b/cpukit/libblock/include/rtems/bdpart.h
> index d1d81e7..c45e109 100644
> --- a/cpukit/libblock/include/rtems/bdpart.h
> +++ b/cpukit/libblock/include/rtems/bdpart.h
> @@ -33,6 +33,7 @@ extern "C" {
>   #endif /* __cplusplus */
>
>   /**
> + * @brief Manage Partitions of a Disk Device
>    * @defgroup rtems_bdpart Block Device Partition Management
>    *
>    * @ingroup rtems_libblock
> @@ -334,6 +335,8 @@ rtems_status_code rtems_bdpart_unmount(
>   );
>
>   /**
> + * @brief Prints the Partition Table @a Partitions with @a Count Partitions
> + *
>    * Prints the partition table @a partitions with @a count partitions to
>    * standard output.
>    */

I thought that we agreed on using complete sentences for group and function 
brief statements.

I would place also the @brief of groups after the @defgroup and @ingroup.

-- 
Sebastian Huber, embedded brains GmbH

Address : Dornierstr. 4, D-82178 Puchheim, Germany
Phone   : +49 89 189 47 41-16
Fax     : +49 89 189 47 41-09
E-Mail  : sebastian.huber at embedded-brains.de
PGP     : Public key available on request.

Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.