RTEMS Doxygen Guidance on @note

[Joel Sherrill]

On Mar 21, 2014 2:02 PM, Gedare Bloom <gedare at rtems.org> wrote:
>
> On Fri, Mar 21, 2014 at 2:48 PM, Joel Sherrill
> <joel.sherrill at oarcorp.com> wrote:
> > Hi
> >
> > Jennifer just pointed out to me that our Doxygen guidance page on
> > the Wiki says not to use @note.
> >
> > I don't recall ever discussing that and I know the page was created
> > to support Google Code-In students initially. Anyone have any
> > recollection of where that rule came from?
> >
> No, but probably anything labelled @note should just go in the
> function description.

The regular API pages have notes sections.

When I use a note, it is for status or anomaly warnings

>
> > --
> > Joel Sherrill, Ph.D.             Director of Research & Development
> > joel.sherrill at OARcorp.com        On-Line Applications Research
> > Ask me about RTEMS: a free RTOS  Huntsville AL 35805
> > Support Available                (256) 722-9985
> >
> > _______________________________________________
> > rtems-users mailing list
> > rtems-users at rtems.org
> > http://www.rtems.org/mailman/listinfo/rtems-users
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/users/attachments/20140321/dbc69030/attachment-0001.html>