[PATCH v2 0/1] Generate application configuration option documentation
Sebastian Huber
sebastian.huber at embedded-brains.de
Thu Aug 6 13:16:15 UTC 2020
This patch adds the application configuration option documentation generated
from specification items:
https://git.rtems.org/rtems-central.git/tree/spec/if/acfg
The header file is generated by the following script and module:
https://git.rtems.org/rtems-central.git/tree/spec2doc.py
https://git.rtems.org/rtems-central.git/tree/rtemsqual/applconfig.py
The module uses currently a hack to resolve references external to specification
items, e.g. sections in the RTEMS Classic API Guide or URLs. I think we need
specialized specification items for these external references.
This patch is huge and contains all application configuration options of
RTEMS. The review objectives for this patch should be:
1. The header file name and location.
2. The general Doxygen markup.
You find an how-to section proposal here:
https://lists.rtems.org/pipermail/devel/2020-August/061161.html
v2:
I significantly improved how specification internal references and
references to external definitions can be made in items for application
configuration options.
Sebastian Huber (1):
Document application configuration options
cpukit/doxygen/appl-config.h | 4182 ++++++++++++++++++++++++++++++++++
1 file changed, 4182 insertions(+)
create mode 100644 cpukit/doxygen/appl-config.h
--
2.26.2
More information about the devel
mailing list