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

[Joel Sherrill]

Just to make sure... is this desire documented in:

http://www.rtems.org/wiki/index.php/GoogleCodeInProjects#Cleanup_Doxygen

Even if it has to be repeated from an earlier task description?

--joel

On 12/21/2012 3:13 AM, Sebastian Huber wrote:
> 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.
>


-- 
Joel Sherrill, Ph.D.             Director of Research & Development
joel.sherrill at OARcorp.com        On-Line Applications Research
Ask me about RTEMS: a free RTOS  Huntsville AL 35805
Support Available                (256) 722-9985