class RDoc::RDoc

要約

rdoc ドキュメントの作成を行うクラスです。

以下のようにして、rdoc コマンドを実行するのと同様に実行します。

require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)

args には rdoc コマンドに渡すのと同様の引数を文字列の配列で指定します。

rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを HTML に変換する部分をライブラリとして使用したい場合、 rdoc/markup を参照してください。

目次

特異メソッド

• add_generator

インスタンスメソッド

• document
• load_options

特異メソッド

add_generator(klass) -> klassRuby 1.9.3 から[permalink][rdoc][edit]

引数 klass で指定したクラスをジェネレータとして登録します。

[PARAM] klass:

登録するクラスを指定します。

[SEE_ALSO] RDoc::Options/カスタムオプション

インスタンスメソッド

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

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

[PARAM] argv:

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

[EXCEPTION] RDoc::Error:

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

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

load_options -> RDoc::OptionsRuby 2.0.0 から Ruby 3.1 で削除[permalink][rdoc][edit]

カレントディレクトリの .rdoc_options ファイルが存在すれば、その内容を読み込んで RDoc::Options オブジェクトを返します。存在しない場合は新しい RDoc::Options オブジェクトを返します。

[EXCEPTION] RDoc::Error:

.rdoc_options ファイルの内容が正しい RDoc::Options の形式でなかった場合に発生します。

[SEE_ALSO] RDoc::Options#write_options