#3707 accepted task

Assign each code file to a Doxygen group

Reported by: Sebastian Huber Owned by: Sebastian Huber
Priority: normal Milestone: 6.1
Component: doc Version: 6
Severity: normal Keywords: qualification
Cc: Blocked By: #3706


Assign each code file (header, C source, assembler) to a Doxygen group. Exclude the legacy network stack and test suites. For third-party code decide case by case. Use this template and place it at the top of the file:

 * @file
 * @ingroup RTEMSClassicTasks

Do not use @brief and a file description.

Change History (3)

comment:1 Changed on 02/26/19 at 13:30:45 by Sebastian Huber

Status: assignedaccepted

comment:2 Changed on 02/28/19 at 10:48:03 by Sebastian Huber <sebastian.huber@…>

In feea03b6/rtems:

Remove explicit file names from @file

This makes the @file documentation independent of the actual file name.

Update #3707.

comment:3 Changed on 03/04/19 at 06:55:05 by Sebastian Huber <sebastian.huber@…>

In 9d41fca/rtems:

bsp/altera-cyclone-v: Adjust Doxygen file groups

Update #3707.

Note: See TracTickets for help on using tickets.