Ruby 2.5.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/generatorライブラリ

library rdoc/generator

要約

RDoc が解析したソースコードを RDoc::CodeObject のツリーから その他の形式に出力するためのサブライブラリです。

RDoc には HTML 向けのジェネレータの RDoc::Generator::Darkfish と ri 向けのジェネレータの RDoc::Generator::RI が付属しています。

ジェネレータの登録

RDoc::RDoc.add_generator を呼び出す事でジェネレータの登録が行えます。

class My::Awesome::Generator
  RDoc::RDoc.add_generator self
end

rdoc のオプションの追加

rdoc ではオプションの処理の前に RDoc::Options は各ジェネ レータの #setup_options メソッドを実行します。ジェネレータは 第一引数で 渡される RDoc::Options#option_parser に対して rdoc コマンドのオプ ションを追加できます。rdoc/options の例と OptionParser も併せて参照してください。

ジェネレータのインストール

ソースコードを解析した後は RDoc:RDoc オブジェクトはジェネレータの コンストラクタの引数に RDoc::Store オブジェクトと RDoc::Options オブジェクトを渡して初期化します。

RDoc::Store オブジェクトは解析したソースコードに関する情報を保持 しています。RDoc 3 以前は RDoc::TopLevel オブジェクトがこの 情報を保持しています。ジェネレータを RDoc 3 以前のものから更新す る際には、RDoc::TopLevel を使って記述された処理を置き換える必要が あります。

RDoc は出力を行う際にジェネレータの generate メソッドを呼び出しま す。RDoc::StoreRDoc::CodeObject のツリーのメソッドを使っ て要求される形式のフォーマットを出力してください。

モジュール

RDoc::Generator

RDoc が解析したソースコードを RDoc::CodeObject のツリーから その他の形式に出力するためのクラスです。

サブライブラリ

rdoc/generator/darkfish

HTML を生成するためのサブライブラリです。

rdoc/generator/json_index

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ クスを生成するサブライブラリです。

rdoc/generator/markup

ライブラリ内部で使用します。

rdoc/generator/ri

ri のためのファイルを生成するためのサブライブラリです。