Add autodoc markup for tagging OS-specific symbols.
There are several symbols (eg System.RegGetValue()
or System.getpwent()
) that are OS-specific.
Add support for a semantic markup that can indicate that the former is WIN32 and the latter is POSIX.
It is likely that an hierarchy of OSes may be needed in case the presentation wants to support filtering (eg MacOS X is a BSD which in turn is a subset of POSIX).
Having a dedicated markup makes for a consistent formatting of the information.
The initial implementation needs to:
- Document the markup.
- Parse the markup.
- Save the information in the generated
*.xml
files. - Render the information.
NB: There might be a similar issue with respect to CPU/architecture dependent symbols so consider having a markup that supports both (or generic) restrictions. Eg:
@requires __OS__.POSIX
@requires __CPU__.IA64
@requires Nettle.GCM