Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > rdoc/rdocライブラリ > RDoc::RDocクラス > document

instance method RDoc::RDoc#document

document(argv) -> nil[permalink][rdoc]

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。

[PARAM] argv:

コマンドラインで rdoc コマンドに指定するのと同じ引数を文字 列の配列で指定します。

[EXCEPTION] RDoc::RDocError:

ドキュメントの処理中にエラーがあった場合に発生します。

指定できるオプションについては、rdoc/使いかた を参照してくださ い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の doc 以下に出力します。