RTEMS Coding Style for Header Files

Cynthia Rempel cynt6007 at vandals.uidaho.edu
Wed Dec 12 06:06:12 UTC 2012

Hi Gedare Bloom and Sabastian Huber,

Thanks! The doxygen directions are much easier to follow.

Cynthia Rempel
From: rtems-devel-bounces at rtems.org [rtems-devel-bounces at rtems.org] on behalf of Gedare Bloom [gedare at rtems.org]
Sent: Monday, December 10, 2012 7:12 AM
To: Sebastian Huber
Subject: Re: RTEMS Coding Style for Header Files

I agree. If you want to just paste this header in a <pre></pre> block
on either the Doxygen page or the Coding Conventions page, I can make
the minor edits later and we can work from there. It would be good
probably to have a few of these examples by code. A doxygen-ated
header and supercore source code come to mind. I forgot to paste the
Doxygen link before, here it is [1]

[1] http://wiki.rtems.org/wiki/index.php/Doxygen_Recommendations

On Mon, Dec 10, 2012 at 7:46 AM, Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
> On 12/10/2012 01:24 PM, Gedare Bloom wrote:
>> 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.
> My preferred location for this would be the wiki page.
> --
> Sebastian Huber, embedded brains GmbH
> Address : Dornierstr. 4, D-82178 Puchheim, Germany
> Phone   : +49 89 18 94 80 741-16
> Fax     : +49 89 18 94 80 741-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

More information about the devel mailing list