検索結果

RDoc::Generator (21032.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 のツリーから その他の形式に出力するためのクラスです。

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

• RDoc
• RDoc::CodeObject

rdoc/generator (12212.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 のツリーから その他の形式に出力するためのサブライブラリです。

...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
• rdoc/generator/darkfish
• rdoc/generator/json_index
• rdoc/generator/markup
• rdoc/generator/ri

RDoc::RDoc.add_generator(klass) -> klass (12107.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::Darkfish::GENERATOR_DIR -> String (12101.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::Generator::Darkfish

rdoc/generator/json_index (12030.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

• ライブラリ

他のジェネレータが生成する 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...

...# ...
@base_dir = Pathname.pwd.expand_path

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

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

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

検索用のインデックスは JSON ファイルに...

• RDoc::Generator::JsonIndex
• json

絞り込み条件を変える

rdoc/generator/darkfish (12000.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

• ライブラリ

HTML を生成するためのサブライブラリです。

HTML を生成するためのサブライブラリです。

• RDoc::Generator::Darkfish
• erb
• fileutils
• pathname
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/generator
• rdoc/generator/markup
• rdoc/ghost_method
• rdoc/include
• rdoc/markup
• rdoc/markup/formatter
• rdoc/markup/to_html
• ...

rdoc/generator/markup (12000.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::Generator::Markup
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/generator
• rdoc/ghost_method
• rdoc/include
• rdoc/markup
• rdoc/markup/formatter
• rdoc/markup/to_html
• rdoc/markup/to_html_crossref
• rdoc/meta_method
• rdoc/normal_class
• rdoc/normal_module
• ...

rdoc/generator/ri (12000.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

• ライブラリ

ri のためのファイルを生成するためのサブライブラリです。

ri のためのファイルを生成するためのサブライブラリです。

• RDoc::Generator::RI

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

• 2.2.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

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

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

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

• RDoc::Options