Opened on 02/26/19 at 14:22:06

Closed on 06/01/20 at 11:27:20

#3708 closed task (fixed)

Remove Doxygen comments from confdefs.h

Reported by: Sebastian Huber Owned by: Sebastian Huber
Priority: normal Milestone: 5.1
Component: doc Version: 5
Severity: normal Keywords: qualification
Cc: Blocked By:
Blocking: #3705

Description

The confdefs.h file contains Doxygen comments. They are not helpful and lead to a confusing Doxygen output. The documentation place for the RTEMS configuration is the RTEMS Classic API Guide:

​https://docs.rtems.org/branches/master/c-user/configuring_a_system.html

Change History (4)

comment:1 Changed on 02/27/19 at 23:48:33 by Chris Johns

Can a link be added so doxygen generate docs point to the documentation?

comment:2 Changed on 02/27/19 at 23:52:08 by Joel Sherrill

I am against a patch that removes them without verifying that all info in the Doxygen comments is already in the Classic API Guide. There has to be at least some information in confdefs.h comments that isn't in the manual.

comment:3 Changed on 02/28/19 at 14:18:19 by Sebastian Huber

I think we all agreed that the user documentation is in the manuals and Doxygen is for internal use, e.g. for RTEMS contributors.

If something is in Doxygen comments in confdefs.h which is not in the manual, then of course we should update the manual.

comment:4 Changed on 06/01/20 at 11:27:20 by Sebastian Huber

Milestone: 6.1 → 5.1
Resolution: → fixed
Status: assigned → closed
Version: 6 → 5

Removing the Doxygen markup from <rtems/confdefs.h> was a side-effect of #3875. With the new specification items for the application configuration options it would be possible to generate Doxygen markup for them: #3994.

Note: See TracTickets for help on using tickets.