Opened on Feb 26, 2019 at 1:28:28 PM

Last modified on Mar 4, 2019 at 6:55:05 AM

#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
Blocking:

Description

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 Feb 26, 2019 at 1:30:45 PM by Sebastian Huber

Status: assigned → accepted

comment:2 Changed on Feb 28, 2019 at 10:48:03 AM 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 Mar 4, 2019 at 6:55:05 AM 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.