検索結果

RDoc::RDoc.add_generator(klass) -> klass (24201.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• 特異メソッド

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

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

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

@see c:RDoc::Options#custom_options...

• RDoc::RDoc

rdoc/generator (6012.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

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

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

=== ジェネレータの登録

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

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

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

=== ジェネレータのインストー...

...RDoc::TopLevel を使って記述された処理を置き換える必要が
あります。

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

• RDoc::Generator
• rdoc/generator/darkfish
• rdoc/generator/json_index
• rdoc/generator/markup
• rdoc/generator/ri

RDoc::Options (12.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• クラス

rdoc コマンドのオプションを解析するためのクラスです。

...詳細に関しては、lib:rdoc#usage を参照してくだ
さい。


===[a:custom_options] カスタムオプション

RDoc のジェネレータでは、RDoc::Options をフックして独自の
オプションを指定できます。

Object::ARGV に --format が含まれていた場合、RD...

...ョンを指定する場合は --format オプションは必ず指定
する必要があります。rdoc --help を実行すると追加したオプションの一覧が
確認できます。

例:

class RDoc::Generator::Spellcheck
RDoc::RDoc.add_generator self

def self.setup_options rd...

...oc_options
op = rdoc_options.option_parser

op.on('--spell-dictionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_dictionary アクセサの定義が必要
rdoc_options.spell_dictionary = dictionary
end
end
end...

• RDoc
• RDoc::Options