tmdoc − Rubyソフトウェアの保守ドキュメントを作成
|
tmdoc [−i INPUT_DIR] [−o OUTPUT_DIR] [−t TITLE] [−e TAB_WIDTH] [−c] [−a] [−v VERB_LEVEL] [−s SENS_LEVEL] [−l LOG_FILE] [−h] [−v] SOURCE_FILE... |
TmDocは与えられたソースファイル(SOURCE_FILE)から DocBook文書を自動的に生成します。
生成されたDocBook文書は、出力先ディレクトリ OUTPUT_DIR 下の多数のファイル “tmdoc.*.docbook” に書かれます。これらのDocBookファイルの中で、トップレベルのファイル名は “tmdoc.home.docbook” です。
[−i INPUT_DIR], [−−input−dir INPUT_DIR]
ソースファイル(SOURCE_FILE)が 置かれているディレクトリ。 デフォルトはカレントディレクトリです。
[−o OUTPUT_DIR], [−−output−dir OUTPUT_DIR]
生成されたDocBook文書が書き込まれるディレクトリ。 デフォルトは “./dbook” です。
注記: このディレクトリはあらかじめ存在し、書き込み可能でなければなりません。
[−t TITLE], [−−title TITLE]
文書の題名。
[−e TAB_WIDTH], [−−tab−width TAB_WIDTH]
ソースコードのタブ幅。 デフォルト値は 8 です。 オプション [−c] も参照のこと。
[−c], [−−[no−]show−code]
文書内にソースコードを追記します。
[−−[no−]show−module−siblings]
モジュール構造上の隣接情報を生成して文書に追記します。
[−−[no−]show−class−siblings]
クラス継承階層上の隣接情報を生成して文書に追記します。
[−a], [−−show−all]
すべてのオプション [−−show−XXX] を有効にします。
[−−[no−]sort−by−name]
章の並びをクラスまたはモジュールの名前順にソートします。
[−v VERB_LEVEL], [−−verbose−level VERB_LEVEL]
発生したイベントのレベルが 与えられたレベル VERB_LEVEL 以下であれば、 そのイベントに関するメッセージを標準エラー出力へ表示します。
レベル VERB_LEVEL は識別子であり、 以下の中のいずれか一つです: debug, progress, info, notice, warn, error, fatal。 レベル debug は 最も高位のレベルであり、最も騒がしくなります。 レベル fatal は 最も低位のレベルであり、最も寡黙になります。 デフォルトは progress です。
[−−quiet]
沈黙モード。 [−−verbose−level fatal]と同じです。
[−s SENS_LEVEL], [−−sensitive−level SENS_LEVEL]
発生したイベントのレベルが 与えられたレベル SENS_LEVEL 以下であれば、 処理を停止して異常終了させます。
レベル SENS_LEVEL は識別子であり、 以下の中のいずれか一つです: notice, warn, error, fatal。 レベル notice は 最も高位のレベルであり、最も敏感になります。 レベル fatal は 最も低位のレベルであり、最も鈍感になります。 デフォルトは fatal です。
[−l LOG_FILE], [−−log−file LOG_FILE]
発生したイベントに関するメッセージが書き込まれるファイル名。
注記: ログ機能は オプション [−v VERB_LEVEL] または [−s SENS_LEVEL] の 影響を受けません。
[−h], [−−help]
ヘルプメッセージを表示します。
[−−version]
バージョンを表示します。
0
正常終了
1
コマンド引数エラー
2
出力(I/O)エラー
3
イベントに起因する異常終了。 オプション [−s SENS_LEVEL] を 参照のこと。
以下の例は、UNIX環境における最も初歩的なTmDocの使用方法です。
(1) 出力先ディレクトリを作成
$ mkdir dbook
(2) TmDocコマンドを実行
$ tmdoc foo.rb
(3) 作成されたDocBookファイルをHTML形式へ変換
$ xsltproc
−−xinclude $DOCBOOK_XSL_DIR/html/docbook.xsl \
> dbook/tmdoc.home.docbook > foo.html
TmDocに関する追加情報は、 TmDocプロジェクトのホームページ [1] で 見つけられるかもしれません。
Ruby's ライセンス
takomachan <takomachan@gmail.com>
Copyright (C) 2011−2012
|
1. |
TmDocプロジェクトのホームページ |
http://www.h6.dion.ne.jp/~machan/tmdoc/