[RTEMS Project] #3706: Create a hierarchy of RTEMS software components using Doxygen groups

[RTEMS trac]

#3706: Create a hierarchy of RTEMS software components using Doxygen groups
-----------------------------+------------------------------
 Reporter:  Sebastian Huber  |       Owner:  Sebastian Huber
     Type:  task             |      Status:  accepted
 Priority:  normal           |   Milestone:  6.1
Component:  doc              |     Version:  6
 Severity:  normal           |  Resolution:
 Keywords:  qualification    |  Blocked By:  3704
 Blocking:  3705, 3707       |
-----------------------------+------------------------------
Description changed by Sebastian Huber:

Old description:

> Create a hierarchy of RTEMS software components using Doxygen groups.
> Review the existing Doxygen groups (software components) first.
>
> https://docs.rtems.org/doxygen/branches/master/modules.html
>
> Grouping should be done by at BSP level architecture and then by BSP.
>
> There should be a device driver group with subgroups for each device
> class and specific device drivers, e.g. a BSP-specific device driver
> belongs to a device class and BSP.
>
> There should be groups for APIs, file systems, support libraries, super
> core, etc.

New description:

 Create a hierarchy of RTEMS software components using Doxygen groups.
 Review the existing Doxygen groups (software components) first.

 https://docs.rtems.org/doxygen/branches/master/modules.html

 Grouping should be done by at BSP level architecture and then by BSP.

 There should be a device driver group with subgroups for each device class
 and specific device drivers, e.g. a BSP-specific device driver belongs to
 a device class and BSP.

 There should be groups for APIs, file systems, support libraries, super
 core, etc.

 * 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
   * Tracing
     * Event Recording
     * Capture Engine
 * Internal
   * C Library Support
   * POSIX
   * Shell
   * Super Core
     * Thread Handler
     * CPU
       * ARM

--

--
Ticket URL: <http://devel.rtems.org/ticket/3706#comment:11>
RTEMS Project <http://www.rtems.org/>
RTEMS Project