<p dir="ltr"><br>
On Mar 21, 2014 2:02 PM, Gedare Bloom <gedare@rtems.org> wrote:<br>
><br>
> On Fri, Mar 21, 2014 at 2:48 PM, Joel Sherrill<br>
> <joel.sherrill@oarcorp.com> wrote:<br>
> > Hi<br>
> ><br>
> > Jennifer just pointed out to me that our Doxygen guidance page on<br>
> > the Wiki says not to use @note.<br>
> ><br>
> > I don't recall ever discussing that and I know the page was created<br>
> > to support Google Code-In students initially. Anyone have any<br>
> > recollection of where that rule came from?<br>
> ><br>
> No, but probably anything labelled @note should just go in the<br>
> function description.</p>
<p dir="ltr">The regular API pages have notes sections.</p>
<p dir="ltr">When I use a note, it is for status or anomaly warnings</p>
<p dir="ltr">><br>
> > --<br>
> > Joel Sherrill, Ph.D.             Director of Research & Development<br>
> > joel.sherrill@OARcorp.com        On-Line Applications Research<br>
> > Ask me about RTEMS: a free RTOS  Huntsville AL 35805<br>
> > Support Available                (256) 722-9985<br>
> ><br>
> > _______________________________________________<br>
> > rtems-users mailing list<br>
> > rtems-users@rtems.org<br>
> > http://www.rtems.org/mailman/listinfo/rtems-users<br>
</p>