RTEMS Coding Style for Header Files

[Sebastian Huber]

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.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: foobar.h
Type: text/x-chdr
Size: 5106 bytes
Desc: not available
URL: <http://lists.rtems.org/pipermail/devel/attachments/20121209/9a407cba/attachment.bin>