The doxygenĬomment tags described above have the same meaning in the interfaceĭescription files.
This is a superset of the XML tags used in doxygen comments. The interfaces are described contains tags for documenting functions.įor the purpose of validation, the XML schema defining this language is Object invocation API documentation is located inline with the interfaceĭescriptions in the XML files listed above. Note that despite its name, the script generates object invocation stubs - not syscall stubs. There is a script in the sel4 repo for generating C header files from a libsel4/sel4_arch_include/aarch64/interfaces/sel4arch.xml.libsel4/sel4_arch_include/aarch32/interfaces/sel4arch.xml.libsel4/sel4_arch_include/x86_64/interfaces/sel4arch.xml.libsel4/sel4_arch_include/ia32/interfaces/sel4arch.xml.libsel4/arch_include/arm/interfaces/sel4arch.xml.libsel4/arch_include/x86/interfaces/sel4arch.xml.The following XML files contain object invocation interface descriptions:
DOXYGEN CUSTOM TAGS CODE
These are more complicated, as the C source code implementing the user-level object invocations functions is generated from some interface descriptions in XML. A Doxyfile containing this configuration isĪ prototype for each system call is declared inĮach function is documented with a comment of the form described above.
DOXYGEN CUSTOM TAGS MANUAL
The correct behaviour of the manual build system depends on a specificĭoxygen configuration.
Then transforms each relevant XML file into the corresponding LaTeX Group’s documentation is in a separate file. Doxygen-generated XML files are placed inĮach API is documented in a separate file. The LaTeX files generated by the translation script are placed in It generates the text “TODO” to help readers of the manual identify Translation script will insert the LaTeX command \todo, defined in If a required part of a function’s documentation is empty, the a description of the return value, unless the function.With the name for use in the manual’s text, and a label for Required DocumentationĮach function in the API must have the following documentation: Note that these must appear within … blocks in ToĪchieve both these goals, we introduce some additional XML tags which weĮxplicitly add to doxygen comments inside … a description of all the custom tags: To the API docs in the manual that aren’t understood by doxygen. Some parts of the API documentation reference other parts of the manual.Īdditionally, there are some custom formatting rules we’d like to apply The script that translates doxygen-generated xml into LaTeX is in: XML) rather than try to coerce doxygen into In this style ourselves from some simple (ie. This is because we already have an established styleįor API documentation in our manual, and it was easier to generate LaTeX A custom script then parses the XML and produces theįinal LaTeX output. Rather than using doxygen’s LaTeX output directly, we use doxygen to To generate API documentation for the manual, we generate LaTeXįiles from doxygen comments which are then included in the manual. The rest of the seL4 manual is written in Common Approachĭocumentation for each seL4 API is written in the form of doxygenĬomments in C header files. Object Invocations, though each process has some parts in common. The process of generating API docs is different between System Calls and Architecture-Independent Object Methods.The API documentation in the manual is divided into the following hierarchy: Some kernel objects and object invocations are specific to a.The message encodes some operation on a Kernel Object. Object Invocations, which are regular message-passing systemĬalls, but whose recipient is effectively the kernel itself, and.
These are true syscalls, rather than object invocations.
0 kommentar(er)
