Opened on 02/26/19 at 13:28:28

Closed on 07/28/23 at 14:39:53

#3707 closed task (fixed)

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 (17)

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

Status: assigned → accepted

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.

comment:4 Changed on 10/24/22 at 11:23:06 by Sebastian Huber <sebastian.huber@…>

In 468f21e/rtems:

bsps: Add Cache Manager implementation group

Update #3707.

comment:5 Changed on 11/30/22 at 08:53:00 by Sebastian Huber

Milestone: 6.1 → 7.1

comment:6 Changed on 02/16/23 at 07:11:35 by Sebastian Huber <sebastian.huber@…>

In bb465c8/rtems:

doxygen: Add Doxygen files to a group

Update #3707.

comment:7 Changed on 07/21/23 at 05:33:09 by Sebastian Huber <sebastian.huber@…>

In 5fb9ebfc/rtems:

doxgen: Document build system provided files

Update #3707.

comment:8 Changed on 07/26/23 at 04:56:38 by Sebastian Huber <sebastian.huber@…>

In f99f5ce/rtems:

libtest: Place files into a Doxygen group

Canonicalize the file headers.

Update #3707.

comment:9 Changed on 07/26/23 at 04:56:40 by Sebastian Huber <sebastian.huber@…>

In 58840ffb/rtems:

rtems: Add files to Doxygen groups

Provide basic Doxygen comments.

Update #3706.
Update #3707.

comment:10 Changed on 07/26/23 at 04:56:42 by Frank Kühndel <frank.kuehndel@…>

In 3e1521ee/rtems:

bsps/sparc: Add files to Doxygen groups

Update #3707.

comment:11 Changed on 07/26/23 at 04:56:44 by Sebastian Huber <sebastian.huber@…>

In 233c21a/rtems:

score: Add files to Doxygen groups

Update #3707.

comment:12 Changed on 07/26/23 at 04:56:46 by Sebastian Huber <sebastian.huber@…>

In 5ba465c0/rtems:

libcsupport: Add file to Doxygen group

Update #3707.

comment:13 Changed on 07/26/23 at 04:56:48 by Sebastian Huber <sebastian.huber@…>

In d3fe128d/rtems:

posix: Add files to Doxygen group

Canonicalize brief descriptions.

Update #3707.

comment:14 Changed on 07/26/23 at 04:56:50 by Sebastian Huber <sebastian.huber@…>

In ec1e500f/rtems:

timecounter: Add files to Doxygen group

Update #3707.

comment:15 Changed on 07/26/23 at 04:56:52 by Sebastian Huber <sebastian.huber@…>

In 1bc5d3e4/rtems:

sys: Add files to Doxygen group

Canonicalize brief descriptions.

Update #3707.

comment:16 Changed on 07/26/23 at 05:09:40 by Sebastian Huber

Milestone: 7.1 → 6.1

For RTEMS 6, the group assignment of files is good enough.

comment:17 Changed on 07/28/23 at 14:39:53 by Sebastian Huber

Resolution: → fixed
Status: accepted → closed
Note: See TracTickets for help on using tickets.