RTEMS Coding Style for Header Files

[Gedare Bloom]

Thanks Sebastian, this looks pretty good overall. A few small
corrections but nothing critical that I saw. Should we store our
conventions on the wiki? Do we want to have a style manual in the
RTEMS doc? I spotted that we already have a similar example for proper
using of Doxygen [1], but I don't think it was linked to for the GCI
students.

I like one space only after the asterisk.

-Gedare

On Sun, Dec 9, 2012 at 11:23 AM, Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
> Hi,
>
> this is my first proposal of a RTEMS Coding Style for Header Files.
>
> Regarding the space uses in Doxygen.  We have one space between the '*' and
> the '@ brief'
>
> /**
>  * @brief A foobar type.
>  *
>  * Use a module prefix followed by a '_' in all names.  Here it is foobar.
>  */
> typedef some_other_type foobar_this_is_a_foobar_type;
>
> vs. two spaces between the '*' and the '@a brief'
>
> /**
>  *  @brief A foobar type.
>  *
>  *  Use a module prefix followed by a '_' in all names.  Here it is foobar.
>  */
> typedef some_other_type foobar_this_is_a_foobar_type;
>
> Which one should we choose?  I am for the first one.
>
> --
> 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.
>
>
> _______________________________________________
> rtems-devel mailing list
> rtems-devel at rtems.org
> http://www.rtems.org/mailman/listinfo/rtems-devel
>