Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/generator/json_indexライブラリ > RDoc::Generator::JsonIndexクラス

class RDoc::Generator::JsonIndex

クラスの継承リスト: RDoc::Generator::JsonIndex < RDoc::Text < Object < Kernel < BasicObject

要約

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

目次

特異メソッド

new

インスタンスメソッド

generate

定数

SEARCH_INDEX_FILE

特異メソッド

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

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

[PARAM] parent_generator:

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

[PARAM] options:

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

インスタンスメソッド

generate -> ()[permalink][rdoc]

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

定数

SEARCH_INDEX_FILE -> String[permalink][rdoc]

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