Doxygen Groups for cpukit

[Gedare Bloom]

On Fri, Mar 8, 2019 at 1:28 AM Sebastian Huber <
sebastian.huber at embedded-brains.de> wrote:

> On 07/03/2019 21:57, Joel Sherrill wrote:
> > On Thu, Mar 7, 2019 at 2:55 PM Chris Johns <chrisj at rtems.org
> > <mailto:chrisj at rtems.org>> wrote:
> >
> >     On 8/3/19 3:24 am, Sebastian Huber wrote:
> >     > On 07/03/2019 15:19, Joel Sherrill wrote:
> >     >> On Thu, Mar 7, 2019 at 7:19 AM Sebastian Huber
> >     >> <sebastian.huber at embedded-brains.de
> >     <mailto:sebastian.huber at embedded-brains.de>
> >     >> <mailto:sebastian.huber at embedded-brains.de
> >     <mailto:sebastian.huber at embedded-brains.de>>> wrote:
> >     >> For the shell, very little is really a public API. Most is
> >     internal.
> >     >> I suspect this applies in many places.
> >     >
> >     > You have rtems_shell_init() etc. functions for the public API.
> >
> >     I was looking at this file today and it could benefit from
> >     becoming just the
> >     public interfaces.
> >
> >
> > Would Doxygen benefit in general from having two runs? One that is all
> > public
> > interfaces and another that is everything?
> >
>
> Some files contain API and internal stuff. With a top-level API group it
> is transparent to the user what is meant for direct use in applications.
> Also, I was told several times that the primary user facing
> documentation is docs.rtems.org and not Doxygen.
>
>
Yes, we have to date focused on Doxygen as a tool for RTEMS Development
itself.

Considering the quality of our manuals, I don't see that a DOxygen for
application development would be entirely useful.


> --
> Sebastian Huber, embedded brains GmbH
>
> Address : Dornierstr. 4, D-82178 Puchheim, Germany
> Phone   : +49 89 189 47 41-16
> Fax     : +49 89 189 47 41-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.
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20190311/281ee9e9/attachment-0002.html>