radadrdoc - ドキュメントジェネレータ
/usr/bin/radadrdoc [-h] -o {adr, docbook, docbook-man, man, html,
rmdoc, spec-odoc}
adr
radadrdoc コマンドは、ADR IDL ドキュメント処理ツールです。この主な目的は、ADR 仕様のドキュメントを生成することです。
すべての呼び出しで、指定された adr が ADR スキーマに対して妥当かどうかが検証されます。
サポートしているオプションは、次のとおりです。
adr のインタフェース定義に対して指定された形式でドキュメントを生成します。インタフェース定義のさまざまな部分をサマリー要素およびドキュメント要素で装飾することによって、ドキュメントを改善できます。次の形式がサポートされています。
ドキュメント処理向けに拡張された ADR IDL 形式。
docbook-html 形式の原型である標準 DocBook 形式 (記事)。
man 形式の原型である DocBook 形式のマニュアルページコンテンツ。
DocBook 記事形式からの変換によって生成される HTML コンテンツ。
[nt]roff 形式のマニュアルページ。
サマリー要素およびドキュメント要素を削除した adr
odoctool 用の bundlespec ファイル。詳細は、odoctool(1) のマニュアルページを参照してください。
ヘルプメッセージを表示して終了します。
出力形式。
次のオペランドがサポートされています。
タイプおよびインタフェースの定義を生成する必要がある API 指定へのパス。
次のコマンドは、myapi.adr に定義された API の C クライアントドキュメントを記述するマニュアルページを生成します。
$ radadrdoc -o man myapi.adr > myapi-1.3rad
コアの ADR RelaxNG スキーマ定義。
ドキュメント要素のための ADR RelaxNG スキーマ定義。
属性についての詳細は、マニュアルページの attributes(7) を参照してください。
|