クエリ:C > クエリ:Darkfish

...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 は各ジェネ...

...RDoc::Options#option_parser に対して rdoc コマンドのオプ
ションを追加できます。lib:rdoc/options#custom_options の例と
OptionParser も併せて参照してください。

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

ソースコードを解析した後は RDoc:RDoc オブ...

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

定数

darkfish のバージョンです。

...
darkfish のバージョンです。...

絞り込み条件を変える

rdoc/generator/json_index (6012.0)

ライブラリ

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

...です。

This generator is derived from sdoc by Vladimir Kolesnikov and
contains verbatim code written by him.

このジェネレータは HTML ジェネレータと一緒に使うために設計されています。:

class RDoc::Generator::Darkfish
def initialize options
# ......

...ath

@json_index = RDoc::Generator::JsonIndex.new self, options
end

def generate
# ...
@json_index.generate
end
end

=== インデックスフォーマット

検索用のインデックスは JSON ファイルに出力されます。search_data という
グロー...

...var search_data = {
"index": {
"searchIndex":
["a", "b", ...],
"longSearchIndex":
["a", "a::b", ...],
"info": [
["A", "A", "A.html", "", ""],
["B", "A::B", "A::B.html", "", ""],
...
]
}
}

searchIndex、longSearchIndex、in...

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

インスタンスメソッド

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

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

定数

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

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

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

別のキーワード

種類

ライブラリ

クラス

キーワード

検索結果

先頭5件

RDoc::Generator::Darkfish (21000.0)

rdoc/generator/darkfish (12000.0)

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

rdoc/generator (6134.0)

RDoc::Generator::Darkfish::VERSION -> &#39;3&#39; (6016.0)

rdoc/generator/json_index (6012.0)

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

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

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