/usr/bin/radadrdoc {-o docbook | docbook-man | man | rmdoc} 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:
Standard docbook format.
Man page content in a docbook format, a precursor to man format.
A man page in [nt]roff format.
adr, with the summary and doc elements removed.
The following operands are supported:
The path to the API specification for which type and interface definitions must be generated.
The core ADR RelaxNG schema definition.
The ADR RelaxNG schema definition for documentation elements.
See attributes (5) for descriptions of the following attributes:
|