[GCI-Mentors] Doxygen tasks

Jennifer Averett Jennifer.Averett at OARcorp.com
Sun Dec 16 17:46:39 UTC 2012


This looks good :-)

I just released a few more doxygen tasks and we are down to 
17 unpublished.

Jennifer Averett
On-Line Applications Research
________________________________________
From: gci2012-mentors-bounces at rtems.org [gci2012-mentors-bounces at rtems.org] On Behalf Of Sebastian Huber [sebastian.huber at embedded-brains.de]
Sent: Sunday, December 16, 2012 9:25 AM
To: Gedare Bloom
Cc: RTEMS Devel; gci2012-mentors at rtems.org
Subject: Re: [GCI-Mentors] Doxygen tasks

On 16/12/12 15:36, Gedare Bloom wrote:
> Here are a few ideas for GCI tasks. If no one has objections we can
> try to get them set to go.
>
> * Convert function @brief from "Table of Contents" to "Topic sentence" style.
> * Replace @a with @param.
> * Replace @return with @retval statements.
> * Put all @{ for @defgroup, @name statements in the same comment block
> as the defgroup/name statement.
> * Ensure all @{ have matching @}
> * Identify what @ingroup do not have a @defgroup
> ** Add defgroup for the missing ones

This list looks great.

--
Sebastian Huber, embedded brains GmbH

Address : Obere Lagerstr. 30, D-82178 Puchheim, Germany
Phone   : +49 89 18 90 80 79-6
Fax     : +49 89 18 90 80 79-9
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.

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




More information about the devel mailing list