class RDoc::Generator::JsonIndex

要約

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

目次

特異メソッド

• new

インスタンスメソッド

• generate

定数

• SEARCH_INDEX_FILE

継承しているメソッド

RDoc::Textから継承しているメソッド

• expand_tabs
• flush_left
• markup
• normalize_comment
• parse
• strip_hashes
• strip_newlines
• strip_stars

特異メソッド

new(parent_generator, options) -> RDoc::Generator::JsonIndex[permalink][rdoc][edit]

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

[PARAM] parent_generator:

親となるジェネレータオブジェクトを指定します。 RDoc::Generator::JsonIndex#class_dir や #file_dir を決めるのに使用します。他のジェネレータとは異なり、RDoc::Store オブジェクトではない点に注意してください。

[PARAM] options:

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

インスタンスメソッド

generate -> ()[permalink][rdoc][edit]

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

定数

SEARCH_INDEX_FILE -> String[permalink][rdoc][edit]

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