man pages section 1: User Commands

Exit Print View

Updated: July 2014
 
 

radadrdoc (1)

Name

radadrdoc - Code generator

Synopsis

/usr/bin/radadrdoc {-o docbook | docbook-man | man | rmdoc} adr

Description

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.

Options

The following options are supported:

–o format

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:

docbook

Standard docbook format.

docbook-man

Man page content in a docbook format, a precursor to man format.

man

A man page in [nt]roff format.

rmdoc

adr, with the summary and doc elements removed.

Operands

The following operands are supported:

adr

The path to the API specification for which type and interface definitions must be generated.

Files

/usr/share/lib/xml/rng/radadr.rng.1

The core ADR RelaxNG schema definition.

/usr/share/lib/xml/rng/radadr-doc.rng.1

The ADR RelaxNG schema definition for documentation elements.

Attributes

See attributes (5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availibility
system/management/rad
Interface Stability
Private

See also

rad (1M) , attributes (5)