RTEMS Coding Style for Header Files

[Gedare Bloom]

One issue that needs to be clarified is whether we want to use
@param[] or @a, or a mix depending on the situation.

I lean toward using the @param. Often the @a usage leads to awkward
wording in description text.

On Sat, Dec 15, 2012 at 10:05 AM, Gedare Bloom <gedare at rtems.org> wrote:
> I have incorporated this file in the Doxygen Recommendations and
> Coding Conventions wiki pages, and uploaded a copy to the wiki for
> reference.
>
> More work needs to be done with the Coding Conventions page to codify
> the "RTEMS style" (as it applies to at least supercore code).
>
> 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
>>