radadrdoc - Documentation generator
/usr/bin/radadrdoc [-h] -o {adr, docbook, docbook-man, man, html, rmdoc, spec-odoc} adr
The radadrdoc command is the ADR IDL documentation processing tool. Its primary purpose is to generate documentation for ADR specifications.
All invocations validate the given adr against the ADR schema.
The following options are supported:
Generates documentation in the given format for the interface definition in the adr. Documentation can be improved by decorating the various parts of the interface definition with summary and doc elements. The following formats are supported:
ADR IDL format expanded for documentation processing.
Standard DocBook format (article), a precursor to docbook-html format.
Man page content in a DocBook format, a precursor to man format.
HTML content produced by transformation from DocBook article format.
A man page in [nt]roff format.
adr, with the summary and doc elements removed.
bundlespec file for odoctool. For more information, see the odoctool(1) man page.
Display the help message and exit.
Output format.
The following operands are supported:
The path to the API specification for which type and interface definitions must be generated.
The following command generates a manual page describing the C client documentation for the API defined in myapi.adr:
$ radadrdoc -o man myapi.adr > myapi-1.3rad
The core ADR RelaxNG schema definition.
The ADR RelaxNG schema definition for documentation elements.
See attributes(7) for descriptions of the following attributes:
|