検索結果

RDoc::Generator (54004.0)

• 3.3

• モジュール

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

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

• RDoc
• RDoc::CodeObject

RDoc::Generator::Darkfish::GENERATOR_DIR -> String (27307.0)

• 3.3

• 定数

このファイルの親ディレクトリへのパスを表す文字列です。

このファイルの親ディレクトリへのパスを表す文字列です。

テンプレートなどのリソースを検索するのに内部で使用します。

• RDoc::Generator::Darkfish

RDoc::Options#generator -> Generator (18676.0)

• 3.3

• インスタンスメソッド

コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。

コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。

指定しなかった場合は、HTML に対応する Generator を返します。

• RDoc::Options

RDoc::Options#generator=(val) (18325.0)

• 3.3

• インスタンスメソッド

コマンドライン引数の --fmt オプションと同様の指定を行います。

コマンドライン引数の --fmt オプションと同様の指定を行います。

@param val 設定する Generator を指定します。

• RDoc::Options

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

• 3.3

• 特異メソッド

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

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

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

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

• RDoc::RDoc

絞り込み条件を変える

RDoc::Generator::JsonIndex.new(parent_generator, options) -> RDoc::Generator::JsonIndex (9712.0)

• 3.3

• 特異メソッド

RDoc::Generator::JsonIndex オブジェクトを初期化します。

...
RDoc::Generator::JsonIndex オブジェクトを初期化します。

@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します...

...。
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。

@param options RDoc::Options オブジェクトを指定します。
parent_generator に渡されたものと同...

• RDoc::Generator::JsonIndex
• RDoc::Options

RDoc::Generator::Darkfish#initialize(store, options) -> RDoc::Generator::Darkfish (9355.0)

• 3.3

• インスタンスメソッド

RDoc::Generator::Darkfish オブジェクトを初期化します。

...
RDoc::Generator::Darkfish オブジェクトを初期化します。

@param store RDoc::Store オブジェクトを指定します。

@param options RDoc::Options オブジェクトを指定します。...

• RDoc::Generator::Darkfish
• RDoc::Options
• RDoc::Store

RDoc::Generator::RI#initialize(store, options) -> RDoc::Generator::RI (9355.0)

• 3.3

• インスタンスメソッド

RDoc::Generator::RI オブジェクトを初期化します。

...
RDoc::Generator::RI オブジェクトを初期化します。

@param store RDoc::Store オブジェクトを指定します。

@param options RDoc::Options オブジェクトを指定します。...

• RDoc::Generator::RI
• RDoc::Options
• RDoc::Store

RDoc::Generator::JsonIndex#generate -> () (9052.0)

• 3.3

• インスタンスメソッド

解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出 力します。

...解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。...

• RDoc::Generator::JsonIndex

RDoc::Generator::Darkfish (9004.0)

• 3.3

• クラス

HTML を生成するためのクラスです。

HTML を生成するためのクラスです。

絞り込み条件を変える

RDoc::Generator::Darkfish#generate -> () (9004.0)

• 3.3

• インスタンスメソッド

解析した情報を HTML ファイルや検索用のインデックスに出力します。

解析した情報を HTML ファイルや検索用のインデックスに出力します。

• RDoc::Generator::Darkfish

RDoc::Generator::Darkfish::VERSION -> '3' (9004.0)

• 3.3

• 定数

darkfish のバージョンです。

darkfish のバージョンです。

• RDoc::Generator::Darkfish

RDoc::Generator::JsonIndex (9004.0)

• 3.3

• クラス

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

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

RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE -> String (9004.0)

• 3.3

• 定数

検索インデックスのパスを表す文字列です。

検索インデックスのパスを表す文字列です。

• RDoc::Generator::JsonIndex

RDoc::Generator::Markup (9004.0)

• 3.3

• モジュール

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

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

絞り込み条件を変える

RDoc::Generator::RI (9004.0)

• 3.3

• クラス

ri のためのファイルを生成するためのクラスです。

ri のためのファイルを生成するためのクラスです。

RDoc::Generator::RI#generate -> () (9004.0)

• 3.3

• インスタンスメソッド

解析した情報を ri コマンドから読めるようにファイルに出力します。

解析した情報を ri コマンドから読めるようにファイルに出力します。

• RDoc::Generator::RI

RDoc::Generator::RI::DESCRIPTION -> String (9004.0)

• 3.3

• 定数

このジェネレータの説明を表す文字列です。

このジェネレータの説明を表す文字列です。

• RDoc::Generator::RI

RDoc::Options (40.0)

• 3.3

• クラス

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

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

それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。


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

RDoc のジェネレータでは、RDoc::Options をフックし...

...まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要があります。rdoc --help を実行する...

...ます。

例:

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

def self.setup_options rdoc_options
op = rdoc_options.option_parser

op.on('--spell-dictionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_dicti...

• RDoc
• RDoc::Options