Files
seL4/manual
Gerwin Klein 9956101ba6 manual: handle name duplication between groups
Different API groups may contain the same function name, for instance
IRQ_Control GetTrigger for RISC-V vs the same for ARM. Duplicate
function names with identical parameter lists confuse doxygen, leading
it to generate a single merged xml entry for both, which means one of
the entires will be missing and the other will be potentially wrong.

When the functions are placed in different files and different groups
at the same time, doxygen no longer is confused in all cases.

Therefore:

- generate a separate file for each API group
- generate a separate file group_defs.h that contains group definitions
  and declares group nesting

Unfortunately, this does not seem to always work (e.g. the toplevel
MCS/non-MCS syscalls), so manual inspection is still necessary when
adding new calls and separate doxygen runs for duplicate function names
may be necessary. Generating separate files as above enables this
option, should it become necessary in the future.

Fixes #530

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2023-11-07 16:01:50 +11:00
..
2015-11-09 20:42:28 +01:00
2021-06-17 20:19:51 +10:00
2021-09-30 18:07:19 +10:00
2021-06-17 20:19:51 +10:00
2021-09-30 18:07:19 +10:00
2021-06-17 20:19:51 +10:00
2016-03-17 14:40:53 +11:00

seL4 Reference Manual

To build a PDF use

make

You will need recent version of LaTeX and doxygen.

The main source file is manual.tex, most of the text is in parts/, and most of the API reference is generated with doxygen.