On Thu, Aug 6, 2020 at 7:16 AM Sebastian Huber <sebastian.hu...@embedded-brains.de> wrote: > > 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 generated file should be identified explicitly as a generated file, and perhaps embed the methodology for (re)generating it as well. > 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. > I don't mind the location cpukit/doxygen Should/could we also move cpukit/doxygen.h into that directory? > 2. The general Doxygen markup. > Can you share a generated doxygen html? (I'm being a little lazy not to do it myself.) I skimmed the patch and the markup/content looks fine, but it would be good to skim the output also. > 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 > > _______________________________________________ > devel mailing list > devel@rtems.org > http://lists.rtems.org/mailman/listinfo/devel _______________________________________________ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
