検索結果

RDoc::METHOD_MODIFIERS -> [String] (20002.0)

• 2.1.0
• 2.4.0
• 2.5.0
• 2.7.0
• 3.1
• 3.2
• 3.3
• 3.4

• 定数

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

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

• RDoc

RDoc::Options#rdoc_include -> [String] (15202.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

• インスタンスメソッド

コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。

...コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。

指定しなかった場合は ['.'] を返します。...

• RDoc::Options

RDoc::KNOWN_CLASSES -> {String => String} (15107.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

• 定数

Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。

...Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。

RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"

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

• RDoc

RDoc::RDoc (15077.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 ドキュメントの作成を行うクラスです。

以下のようにして、rdoc コマンドを実行するのと同様に実行します。

require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)

args には rdoc コマンドに渡すのと同様の引数を文字列...

...の配列で指定します。

rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを
HTML に変換する部分をライブラリとして使用したい場合、
rdoc/markup を参照してください。...

• rdoc/markup

RDoc::Markup::ToRdoc (15017.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 形式のドキュメントをマークアップ記法を保持したまま出力させるための
クラスです。...

絞り込み条件を変える

RDoc::Error (14002.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#document(argv) -> nil (12119.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

• インスタンスメソッド

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。

...ドラインで rdoc コマンドに指定するのと同じ引数を文字
列の配列で指定します。

@raise RDoc::Error ドキュメントの処理中にエラーがあった場合に発生します。

指定できるオプションについては、lib:rdoc#usage を参照し...

...てくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の
doc 以下に出力します。...

• RDoc::RDoc

RDoc::Context#add_class_or_module(collection, class_type, name, superclass = nil) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (9864.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

• インスタンスメソッド

collection に name で指定したクラス、モジュールを追加します。

...
collection に name で指定したクラス、モジュールを追加します。

@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、...

...RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param superclass 追加するクラスの親クラスを RDoc::NormalClass オ
ブジェ...

...クトで指定します。

既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。...

• Hash
• RDoc::Context
• RDoc::NormalClass

RDoc::TopLevel#add_class_or_module(collection, class_type, name, superclass) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (9864.0)

• 2.2.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.1
• 3.2
• 3.4

• インスタンスメソッド

collection に name で指定したクラス、モジュールを追加します。

...
collection に name で指定したクラス、モジュールを追加します。

@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、...

...RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param superclass 追加するクラスの親クラスを RDoc::NormalClass オ
ブジェ...

...クトで指定します。

既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。...

• Hash
• RDoc::NormalClass
• RDoc::TopLevel