るりまサーチ (Ruby 2.7.0)

最速Rubyリファレンスマニュアル検索!
25件ヒット [1-25件を表示] (0.059秒)

別のキーワード

  1. rdoc version
  2. rdoc general_modifiers
  3. rdoc/context new
  4. rdoc attr_modifiers
  5. rdoc method_modifiers

検索結果

rdoc (115123.0)

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。

このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ...

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

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

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

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

rdoc/generator (36637.0)

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.add_generator(klass) -> klass (36322.0)

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

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

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

@see c:RDoc::Options#custom_options

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

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

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

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

絞り込み条件を変える

rdoc/generator/json_index (36091.0)

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

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

rdoc/generator/darkfish (36001.0)

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

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

rdoc/generator/markup (36001.0)

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

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

rdoc/generator/ri (36001.0)

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

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

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

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

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

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

絞り込み条件を変える

RDoc::Generator (27097.0)

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

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

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

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

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

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

@...

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

RDoc::Generator::Darkfish (18001.0)

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

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

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

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

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

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

darkfish のバージョンです。

darkfish のバージョンです。

RDoc::Generator::JsonIndex (18001.0)

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

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

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

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

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

絞り込み条件を変える

RDoc::Generator::Markup (18001.0)

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

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

RDoc::Generator::RI (18001.0)

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

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

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

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

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

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

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

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

RDoc::Options (9319.0)

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

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

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


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

RDoc のジェネレータでは、RDoc::Options をフックして独自の
オプションを指定できます。

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

絞り込み条件を変える