クエリ:g > ライブラリ:rdoc > バージョン:3.3

...@param name RDoc::Markup::ToHtml などのフォーマッタに識別させる時
の名前を Symbol で指定します。

@param start 開始の記号を文字列で指定します。

@param stop 終了の記号を文字列で指定します。

例:

require 'rdoc/markup/to_html...

...'

# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup::ToHtml.new
h.add_tag(:STRIKE, "<strike>", "</strike>")...

絞り込み条件を変える

RDoc::Options#coverage_report=(val) (18304.0)

インスタンスメソッド

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

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

@param val 数値オブジェクトか false を指定します。

RDoc::Options#diagram -> bool (18304.0)

インスタンスメソッド

コマンドライン引数の --diagram オプションを指定していた場合、true を返します。そうでない場合は false を返します。

コマンドライン引数の --diagram オプションを指定していた場合、true を返
します。そうでない場合は false を返します。

RDoc::Options#encoding=(val) (18304.0)

インスタンスメソッド

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

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

@param val 設定する Encoding オブジェクトを指定します。

RDoc::Options#extra_accessor_flags -> {String => String} (18304.0)

インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサがキー、アクセサの種類が値のハッシュを返します。

コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。

値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。

RDoc::Options#finish_page_dir (18304.0)

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

RDoc::Options#image_format -> String (18304.0)

インスタンスメソッド

コマンドライン引数の --image-format オプションで指定した名前を文字列の配列で返します。

コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。

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

RDoc::Options#main_page -> String | nil (18304.0)

インスタンスメソッド

コマンドライン引数の --main オプションで指定したファイル名、クラス/モジュール名を返します。

コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。

指定しなかった場合は nil を返します。

RDoc::Options#main_page=(val) (18304.0)

インスタンスメソッド

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

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

@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。

RDoc::Options#merge -> true | nil (18304.0)

インスタンスメソッド

コマンドライン引数の --merge オプションを指定していた場合、true を返します。そうでない場合は nil を返します。

コマンドライン引数の --merge オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。

絞り込み条件を変える

RDoc::Options#page_dir -> Pathname | nil (18304.0)

インスタンスメソッド

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

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

指定されていない場合は nil を返します。

RDoc::Options#page_dir=(val) (18304.0)

インスタンスメソッド

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

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

@param val パスを文字列で指定します。

RDoc::Parser#parse_files_matching(regexp) -> () (18304.0)

インスタンスメソッド

regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、自身を登録します。

...マッチするファイルを解析できるパーサとして、
自身を登録します。

@param regexp 正規表現を指定します。

新しいパーサを作成する時に使用します。

例:

class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end...

RDoc::Parser::C#progress=(val) (18304.0)

インスタンスメソッド

進捗を出力する IO を指定します。

進捗を出力する IO を指定します。

@param val 進捗を出力する IO を指定します。指定しなかった場合は
$stderr が使われます。

RDoc::Parser::Ruby::SINGLE -> "<<" (18304.0)

定数

RDoc::SingleClass type

...
RDoc::SingleClass type...

絞り込み条件を変える

RDoc::RDoc.add_generator(klass) -> klass (18304.0)

特異メソッド

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

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

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

@see c:RDoc::Options#custom_options...

RDoc::Generator (18004.0)

モジュール

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

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

RDoc::GhostMethod (18004.0)

クラス

コメントでのみ参照されるメソッドを表現します。

コメントでのみ参照されるメソッドを表現します。

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

RDoc::Parser::ChangeLog (18004.0)

クラス

ChangeLog ファイルを解析するためのクラスです。

RDoc::SingleClass (18004.0)

クラス

特異クラスを表現するクラスです。

特異クラスを表現するクラスです。

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

絞り込み条件を変える

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

特異メソッド

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

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

@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します...

...。
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。

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

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

インスタンスメソッド

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

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

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

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

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

定数

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

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

インスタンスメソッド

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

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

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

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

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

定数

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

絞り込み条件を変える

RDoc::Generator::Darkfish (9004.0)

クラス

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

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

定数

darkfish のバージョンです。

RDoc::Generator::JsonIndex (9004.0)

クラス

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

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

RDoc::Generator::Markup (9004.0)

モジュール

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

RDoc::Generator::RI (9004.0)

クラス

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

絞り込み条件を変える

RDoc::Parser::ChangeLog#scan -> RDoc::TopLevel (9004.0)

インスタンスメソッド

ChangeLog ファイルを解析します。

...ChangeLog ファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。...

RDoc::ATTR_MODIFIERS -> [String] (307.0)

定数

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

RDoc::CLASS_MODIFIERS -> [String] (307.0)

定数

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

RDoc::CONSTANT_MODIFIERS -> [String] (307.0)

定数

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

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

定数

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

絞り込み条件を変える

RDoc::VERSION -> String (307.0)

定数

RDoc のバージョンを表す文字列を返します。

...
RDoc のバージョンを表す文字列を返します。...

RDoc::CodeObject#comment -> String (304.0)

インスタンスメソッド

自身のコメントを返します。

RDoc::CodeObject#parent_file_name -> String (304.0)

インスタンスメソッド

self.parent のファイル名を返します。

...self.parent のファイル名を返します。

@see RDoc::CodeObject#parent...

RDoc::CodeObject#parent_name -> String (304.0)

インスタンスメソッド

self.parent の名前を返します。

...self.parent の名前を返します。

@see RDoc::CodeObject#parent...

RDoc::Context#add_class(class_type, name, superclass) -> RDoc::SingleClass | RDoc::NormalClass (304.0)

インスタンスメソッド

引数で指定したクラスを追加します。

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

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

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

絞り込み条件を変える

RDoc::Context#add_class_or_module(collection, class_type, name, superclass = nil) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (304.0)

インスタンスメソッド

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

...オ
ブジェクトで指定します。

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

RDoc::Context#add_module(class_type, name) -> RDoc::NormalModule | RDoc::SingleClass | RDoc::NormalClass (304.0)

インスタンスメソッド

引数で指定したモジュールを追加します。

...ram class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

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

@see RDoc::Context#add_class...

RDoc::Context#add_to(array, thing) -> () (304.0)

インスタンスメソッド

array に thing を追加します。

...を指定します。

RDoc::Context#add_alias などで使われています。ライブラリ内部で使
用します。

@see RDoc::Context#add_alias, RDoc::Context#add_attribute,
RDoc::Context#add_constant, RDoc::Context#add_include,
RDoc::Context#add_method, RDoc::Context#add_require...

RDoc::Context#classes -> [RDoc::SingleClass | RDoc::NormalClass] (304.0)

インスタンスメソッド

追加されたクラスの配列を返します。

RDoc::Context#each_classmodule {|m| ... } -> [RDoc::SingleClass | RDoc::NormalClass | RDoc::NormalModule] (304.0)

インスタンスメソッド

追加されたクラス、モジュールに対してブロックを評価します。

...追加されたクラス、モジュールに対してブロックを評価します。

@see RDoc::Context#classes, RDoc::Context#modules...

絞り込み条件を変える

RDoc::Context#name -> String (304.0)

インスタンスメソッド

自身の名前を返します。

自身の名前を返します。

サブクラスによっては、メソッド名やクラス名を意味します。

RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> () (304.0)

インスタンスメソッド

methods で指定した RDoc::AnyMethod、RDoc::Attr の内、 singleton で指定した条件と一致するメソッドすべての可視性を visibility に設定します。

...methods で指定した RDoc::AnyMethod、RDoc::Attr の内、
singleton で指定した条件と一致するメソッドすべての可視性を visibility
に設定します。

@param methods RDoc::AnyMethod、RDoc::Attr オブジェクトの配
列を指定します。

@param vi...

RDoc::Context#unmatched_alias_lists -> {String => RDoc::Alias} (304.0)

インスタンスメソッド

メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。

...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。...

RDoc::Context::Section#comment -> String | nil (304.0)

インスタンスメソッド

section のコメントを返します。

RDoc::Context::Section#inspect -> String (304.0)

インスタンスメソッド

自身の情報を人間に読みやすい文字列にして返します。

絞り込み条件を変える

RDoc::Context::Section#sequence -> String (304.0)

インスタンスメソッド

section のシーケンス番号を文字列で返します。

section のシーケンス番号を文字列で返します。

リンクを作成する時に使われます。

RDoc::Context::Section#title -> String | nil (304.0)

インスタンスメソッド

section のタイトルを返します。

RDoc::KNOWN_CLASSES -> {String => String} (304.0)

定数

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

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

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

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

RDoc::Markdown.new(extensions = DEFAULT_EXTENSIONS, debug = false) (304.0)

特異メソッド

引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブジェクトを初期化します。

...引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブ
ジェクトを初期化します。

@param extensions 有効にする拡張を Symbol の配列で指定します。

@param debug デバッグを有効にするかどうかを指定します。...

RDoc::Markdown::HTML_ENTITIES -> {String => [Integer]} (304.0)

定数

HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。

...HTML の実体参照のマッピングを表す Hash オブジェクトです。
RDoc::Markdown で使用します。...

絞り込み条件を変える

RDoc::Markup#add_html(tag, name) -> () (304.0)

インスタンスメソッド

tag で指定したタグをフォーマットの対象にします。

...::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_html("no", :STRIKE)

h = SM::ToHtml.new
h.add_tag(:STRIKE,...

RDoc::Markup#content -> String (304.0)

インスタンスメソッド

変換する文字列を返します。

...変換する文字列を返します。

rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。

変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる...

RDoc::Markup.new(attribute_manager = nil) -> RDoc::Markup (304.0)

特異メソッド

自身を初期化します。

...自身を初期化します。

@param attribute_manager Rdoc::AttributeManager オブジェクトを指
定します。...

RDoc::Markup::LABEL_LIST_RE -> Regexp (304.0)

定数

ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。

RDoc::Markup::SIMPLE_LIST_RE -> Regexp (304.0)

定数

リストにマッチする正規表現です。ライブラリの内部で使用します。

リストにマッチする正規表現です。ライブラリの内部で使用します。

ラベルの有無を問わずマッチします。

絞り込み条件を変える

RDoc::Options#charset -> String (304.0)

インスタンスメソッド

コマンドライン引数の --charset オプションで指定した文字コードを文字列で返します。

コマンドライン引数の --charset オプションで指定した文字コードを文字列で
返します。

指定しなかった場合は、$KCODE に応じた値になります。

RDoc::Options#css -> String (304.0)

インスタンスメソッド

コマンドライン引数の --style オプションで指定した URL を文字列で返します。

コマンドライン引数の --style オプションで指定した URL を文字列で返しま
す。

RDoc::Options#exclude -> Regexp (304.0)

インスタンスメソッド

コマンドライン引数の --exclude オプションで指定した正規表現を返します。複数指定していた場合は、1 つの Regexp オブジェクトにまとめられたものを返します。

コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。

RDoc::Options#extra_accessors -> Regexp | nil (304.0)

インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべてにマッチする正規表現オブジェクトを返します。

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。

指定しなかった場合は nil を返します。

RDoc::Options#files -> [String] (304.0)

インスタンスメソッド

解析するファイルの一覧を文字列の配列で返します。

絞り込み条件を変える

RDoc::Options#markup -> String (304.0)

インスタンスメソッド

コマンドライン引数の --markup オプションで指定したフォーマットを返します。

...コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。

指定されていない場合は 'rdoc' を返します。...

RDoc::Options#op_dir -> String (304.0)

インスタンスメソッド

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

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

--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。

@return 設定されたディレクトリを文字列で返します。

RDoc::Options#op_name -> String (304.0)

インスタンスメソッド

コマンドライン引数の --opname オプションで指定した名前を文字列で返します。

コマンドライン引数の --opname オプションで指定した名前を文字列で返しま
す。

RDoc::Options#parse(argv) -> () (304.0)

インスタンスメソッド

コマンドライン引数を解析します。

コマンドライン引数を解析します。

@param argv コマンドライン引数を文字列の配列で指定します。

また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。

* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合

RDoc::Options#rdoc_include -> [String] (304.0)