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

[Jennifer Averett]

Hi Cynthia,

I think the issue is that an @brief that is not in an @file section will appear in paragraph
format in the html output.  Where an @ brief after an @file section will appear in a table
of contents so those two places need different formats.

Jennifer Averett
On-Line Applications Research
________________________________________
From: rtems-devel-bounces at rtems.org [rtems-devel-bounces at rtems.org] On Behalf Of Cynthia Rempel [cynt6007 at vandals.uidaho.edu]
Sent: Sunday, December 23, 2012 10:13 PM
To: Sebastian Huber; rtems-devel at rtems.org
Subject: RE: [1/1] cpukit/libblock Doxygen Enhancement Task #1

Hello Sebastian Huber,

At the time I submitted the patch, the wiki directions seemed to indicate that using complete sentences was part of the "cleaning up Doxygen comments" task (step 2), not the "creating Doxygen comments" task (step 1).

In the future, I will make sure the @brief is below the @defgroup and @ingroup, per this email, I also just changed the wiki to reflect the @brief being below the @ingroup.

Thanks,
Cynthia Rempel
________________________________________
From: rtems-devel-bounces at rtems.org [rtems-devel-bounces at rtems.org] on behalf of Sebastian Huber [sebastian.huber at embedded-brains.de]
Sent: Friday, December 21, 2012 1:13 AM
To: rtems-devel at rtems.org
Subject: Re: [1/1] cpukit/libblock Doxygen Enhancement Task #1

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.


_______________________________________________
rtems-devel mailing list
rtems-devel at rtems.org
http://www.rtems.org/mailman/listinfo/rtems-devel



_______________________________________________
rtems-devel mailing list
rtems-devel at rtems.org
http://www.rtems.org/mailman/listinfo/rtems-devel