Doxygen Groups for cpukit

[Sebastian Huber]

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>> wrote:
>
>     Hello,
>
>     I adjusted several hundred Doxygen groups in the BSP area this
>     week. It
>     is not finished, but it is now in a much better shape. My next
>     step is
>     to adjust the groups in the cpukit area. I propose the following
>     coarse
>     structure:
>
>     * Board Support Packages
>     * Device Drivers
>        * Block Devices
>          * Block Device Buffer Management
>          * Block Device Disk Management
>          * Block Device Management
>            * XYZ Block Device
>          * Block Device Partition Management
>        * Cache
>          * XYZ Cache Support
>        * Console
>          * Termios
>            * XYZ Driver
>        * Framebuffer
>          * XYZ Driver
>        * I2C
>          * Bus Driver
>            * XYZ Driver
>          * Device Driver
>            * XYZ Driver
>        * Legacy I2C
>        * Legacy Network
>        * RTC
>            * XYZ Driver
>        * Serial Mouse
>            * XYZ Driver
>        * SPI
>          * Bus Driver
>            * XYZ Driver
>          * Device Driver
>            * XYZ Driver
>     * API
>        * Classic
>          * Tasks
>        * Dynamic Loading
>        * File Systems
>        * Memory Management
>        * Shell
>
> 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.

>
>        * Tracing
>          * Event Recording
>          * Capture Engine
>     * Internal
>        * C Library Support
>        * POSIX
>
>
> For POSIX and C Library Support, some significant portion of the 
> contents are public APIs.
> Some should be included in APIs and some in Internal.

The public POSIX and C Library API is mostly in Newlib header files.

>
>        * Super Core
>          * Thread Handler
>          * CPU
>            * ARM
>
>     -- 
>     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
>     <mailto: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 <mailto:devel at rtems.org>
>     http://lists.rtems.org/mailman/listinfo/devel
>

-- 
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.