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

...rdoc ドキュメントの作成を行うクラスです。

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

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

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

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

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

RDoc::Markup::ToRdoc (45052.0)

クラス

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるためのクラスです。

...RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
クラスです。...

RDoc::Error (42007.0)

クラス

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

RDoc::RDoc#document(argv) -> nil (36358.0)

インスタンスメソッド

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

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

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

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

インスタンスメソッド

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

インスタンスメソッド

クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。

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

インスタンスメソッド

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

RDoc::TopLevel.all_classes_and_modules -> [RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule] (28861.0)

特異メソッド

RDoc が収集したクラス、モジュールを配列で返します。

...
RDoc が収集したクラス、モジュールを配列で返します。...

絞り込み条件を変える

RDoc::TopLevel.find_class_named(name) -> RDoc::NormalClass | RDoc::SingleClass | nil (28558.0)

特異メソッド

RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つからなかった場合は nil を返します。

...
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ
からなかった場合は nil を返します。

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

RDoc::Context#constants -> [RDoc::Constant] (28003.0)

インスタンスメソッド

追加された RDoc::Constant の配列を返します。

...追加された RDoc::Constant の配列を返します。...

RDoc::Context#includes -> [RDoc::Include] (28003.0)

インスタンスメソッド

追加された RDoc::Include の配列を返します。

...追加された RDoc::Include の配列を返します。...

絞り込み条件を変える

RDoc::Context#sections -> RDoc::Context::Section (28003.0)

インスタンスメソッド

追加された RDoc::Context::Section の配列を返します。

...追加された RDoc::Context::Section の配列を返します。...

RDoc::Markup::ToRdoc.new(markup = nil) -> RDoc::Markup::ToRdoc (27943.0)

特異メソッド

自身を初期化します。

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

@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。...

RDoc::CodeObject#section -> RDoc::Context::Section (27907.0)

インスタンスメソッド

所属している section を返します。

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

インスタンスメソッド

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

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

RDoc::Parser::Simple#scan -> RDoc::TopLevel (27739.0)

インスタンスメソッド

自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析します。

...自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し
ます。

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

絞り込み条件を変える

RDoc::Context#add_constant(const) -> () (27736.0)

インスタンスメソッド

引数で指定した RDoc::Constant オブジェクトを追加します。

...引数で指定した RDoc::Constant オブジェクトを追加します。

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

RDoc::Context#add_include(an_include) -> () (27736.0)

インスタンスメソッド

引数で指定した RDoc::Include オブジェクトを追加します。

...引数で指定した RDoc::Include オブジェクトを追加します。

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

RDoc::Context#each_constant {|c| ... } -> [RDoc::Constant] (27706.0)

インスタンスメソッド

追加された RDoc::Constant に対してブロックを評価します。

...追加された RDoc::Constant に対してブロックを評価します。...

RDoc::Context#each_attribute {|a| ... } -> [RDoc::Attr] (27703.0)

インスタンスメソッド

追加された RDoc::Attr に対してブロックを評価します。

...追加された RDoc::Attr に対してブロックを評価します。...

RDoc::Context#each_method {|m| ... } -> [RDoc::AnyMethod] (27703.0)

インスタンスメソッド

追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト) に対してブロックを評価します。

...追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト)
に対してブロックを評価します。...

絞り込み条件を変える

RDoc::Parser::C#scan -> RDoc::TopLevel (27691.0)

インスタンスメソッド

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメントを解析します。

...C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析します。

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

RDoc::Options#encoding -> Encoding (27652.0)

インスタンスメソッド

コマンドライン引数の --encoding オプションを指定していた場合、指定したエンコーディングに対応する Encoding オブジェクトを返します。

コマンドライン引数の --encoding オプションを指定していた場合、指定した
エンコーディングに対応する Encoding オブジェクトを返します。

指定しなかった場合は Encoding.default_external の値を返します。

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

インスタンスメソッド

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

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

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

RDoc::Parser::Markdown#scan -> RDoc::TopLevel (27643.0)

インスタンスメソッド

Markdown 形式で記述されたファイルを解析します。

...Markdown 形式で記述されたファイルを解析します。

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

RDoc::Parser::RD#scan -> RDoc::TopLevel (27643.0)

インスタンスメソッド

RD 形式で記述されたファイルを解析します。

...RD 形式で記述されたファイルを解析します。

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

絞り込み条件を変える

RDoc::Parser::Ruby#scan -> RDoc::TopLevel (27643.0)

インスタンスメソッド

Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

...Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

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

RDoc::Context#current_section -> RDoc::Context::Section (27607.0)

インスタンスメソッド

現在の section を返します。

RDoc::Context#find_enclosing_module_named(name) -> RDoc::NormalModule | nil (27607.0)

インスタンスメソッド

find a module at a higher scope

RDoc::Parser.can_parse(file_name) -> RDoc::Parser | nil (27607.0)

特異メソッド

file_name を解析できるパーサクラスを返します。見つからなかった場合は nil を返します。

file_name を解析できるパーサクラスを返します。見つからなかった場合は
nil を返します。

@param file_name 解析するファイルの名前を指定します。

RDoc::CodeObject#comment=(comment) (27604.0)

インスタンスメソッド

自身のコメントを comment に設定します。

自身のコメントを comment に設定します。

ただし、comment が空文字列だった場合は何もしません。

@param comment コメントを文字列で指定します。

絞り込み条件を変える

RDoc::Context::Section#set_comment(comment) -> () (27604.0)

インスタンスメソッド

自身にコメントを設定します。

自身にコメントを設定します。

@param comment 文字列を指定します。

comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。

# ---------------------
# :section: The title
# The body
# ---------------------

RDoc::Markup::Formatter#convert(content) -> () (27604.0)

インスタンスメソッド

content で指定された文字列を変換します。

content で指定された文字列を変換します。

@param content 変換する文字列を指定します。

RDoc::Parser::Simple#remove_private_comments(comment) -> String (27604.0)

インスタンスメソッド

行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返します。

行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。

@param comment 対象の文字列を指定します。

@return コメントが削除された文字列を返します。

RDoc::Context#unmatched_alias_lists=(val) (27502.0)

インスタンスメソッド

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

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

@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。...

RDoc::CodeObject#start_doc -> () (27406.0)

インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまでの間、ドキュメントに含めます。

...たコメントを RDoc::CodeObject#stop_doc を呼び出すまで
の間、ドキュメントに含めます。

:startdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を true に設定します。

@see RDoc::CodeObject#end_d...

絞り込み条件を変える

RDoc::CodeObject#stop_doc -> () (27406.0)

インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すまでの間、ドキュメントに含めません。

...コメントを RDoc::CodeObject#start_doc を呼び出すま
での間、ドキュメントに含めません。

:stopdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を false に設定します。

@see RDoc::CodeObject#star...

RDoc::Markup#add_special(pattern, name) -> () (27376.0)

インスタンスメソッド

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にします。

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

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'

class WikiHtml < SM::ToHtml
def handle_special_WIKIWORD(special)
"<font color=red>" +...

RDoc::Text#normalize_comment(text) -> String (27376.0)

インスタンスメソッド

引数から行頭のスペースや改行文字などを削除します。

...から行頭のスペースや改行文字などを削除します。

詳しくは [SEE ALSO] の各メソッドを参照してください。

@param text 文字列を指定します。

@see RDoc::Text#strip_hashes, RDoc::Text#expand_tabs,
RDoc::Text#flush_left, RDoc::Text#strip_newlines...

RDoc::CodeObject (27358.0)

クラス

RDoc のコードツリーを表現するクラスの基本クラスです。

...RDoc のコードツリーを表現するクラスの基本クラスです。

以下は RDoc::CodeObject のサブクラスのツリーです。

//emlist{
* RDoc::Context
* RDoc::TopLevel
* RDoc::ClassModule
* RDoc::AnonClass
* RDoc::NormalClass
* RDoc::NormalModule
* RD...

...oc::SingleClass
* RDoc::AnyMethod
* RDoc::GhostMethod
* RDoc::MetaMethod
* RDoc::Alias
* RDoc::Attr
* RDoc::Constant
* RDoc::Require
* RDoc::Include
//}...

RDoc::CodeObject#remove_classes_and_modules -> () (27352.0)

インスタンスメソッド

何もしません。RDoc::CodeObject#document_children= に false を指定した時のコールバックとして呼び出されます。オーバーライドして使用します。

...何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。...

絞り込み条件を変える

RDoc::CodeObject#remove_methods_etc -> () (27352.0)

インスタンスメソッド

何もしません。RDoc::CodeObject#document_self= に false を指定した時のコールバックとして呼び出されます。オーバーライドして使用します。

...何もしません。RDoc::CodeObject#document_self= に false を指定した
時のコールバックとして呼び出されます。オーバーライドして使用します。...

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

インスタンスメソッド

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

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

RDoc::Options::SPECIAL -> [String] (27352.0)

定数

--write-options を指定した際に .rdoc_options ファイルに保存されないオプションの一覧を返します。

...--write-options を指定した際に .rdoc_options ファイルに保存されないオプ
ションの一覧を返します。...

RDoc::CodeObject#document_children=(val) (27340.0)

インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるかどうかを設定します。

...トに含めるか
どうかを設定します。

:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、上記をドキュメントに含めます。

@see RDoc::CodeObject#document_self=,
RDoc::CodeObject#remove_classes_and_modules...

RDoc::CodeObject#document_self=(val) (27340.0)

インスタンスメソッド

自身をドキュメントに含めるかどうかを設定します。

...c: を指定した時に true が設定されます。
:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、自身をドキュメントに含めます。

@see RDoc::CodeObject#document_children=,
RDoc::CodeObject#remove_methods_etc...

絞り込み条件を変える

RDoc::CodeObject#section=(val) (27340.0)

インスタンスメソッド

所属する section を設定します。

...所属する section を設定します。

@param val RDoc::Context::Section オブジェクトを指定します。...

RDoc::Markup#convert(str, formatter) -> object | "" (27340.0)

インスタンスメソッド

str で指定された文字列を formatter に変換させます。

str で指定された文字列を formatter に変換させます。

@param str 変換する文字列を指定します。

@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。

変換結果は formatter によって文字列や配列を返します。

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

インスタンスメソッド

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

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

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

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

例:

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

RDoc::CodeObject#document_children -> bool (27322.0)

インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるかどうかを返します。

...自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを返します。

@see RDoc::CodeObject#document_self...

RDoc::CodeObject#document_self -> bool (27322.0)

インスタンスメソッド

自身をドキュメントに含めるかどうかを返します。

...自身をドキュメントに含めるかどうかを返します。

@see RDoc::CodeObject#document_children...

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

@param val 設定するパターンを Regexp オブジェクトで指定します。

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

インスタンスメソッド

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

RDoc::CodeObject#documented? -> bool (27304.0)

インスタンスメソッド

出力すべきドキュメントがあるかどうかを返します。

絞り込み条件を変える

RDoc::Context#find_local_symbol(symbol) (27304.0)

インスタンスメソッド

Finds a method, constant, attribute, module or files named +symbol+ in this context

Finds a method, constant, attribute, module or files named +symbol+ in
this context

RDoc::Context#initialize_classes_and_modules -> () (27304.0)

インスタンスメソッド

追加されたクラスやモジュールをクリアします。

RDoc::Context#initialize_methods_etc -> () (27304.0)

インスタンスメソッド

追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れていないものを含む)、require されたファイル、include されたファイル、定数をクリアします。

追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて
いないものを含む)、require されたファイル、include されたファイル、定数
をクリアします。

RDoc::Context#record_location(toplevel) (27304.0)

インスタンスメソッド

Record the file that we happen to find it in

RDoc::Context#set_current_section(title, comment) -> () (27304.0)

インスタンスメソッド

Handle sections

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

定数

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

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

定数

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

絞り込み条件を変える

RDoc::Markdown#css -> bool (27304.0)

インスタンスメソッド

CSS を記述した場合に出力に含めるかどうかを返します。

CSS を記述した場合に出力に含めるかどうかを返します。

デフォルトでは false を返します。

RDoc::Markdown#css=(val) (27304.0)

インスタンスメソッド

CSS を記述した場合に出力に含めるかどうかを設定します。

RDoc::Markup::SPACE -> ?\s (27304.0)

定数

空白文字です。?\s を返します。ライブラリの内部で使用します。

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

インスタンスメソッド

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

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

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

RDoc::Options#coverage_report -> Integer | false (27304.0)

インスタンスメソッド

コマンドライン引数の --coverage-report オプションを指定していた場合、指定した数値を返します。

コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

RDoc::Options#force_output -> bool (27304.0)

インスタンスメソッド

コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返します。

コマンドライン引数の --force_output オプションを指定していた場合、true
を返します。--no-force_output オプションを指定していた場合、false を返
します。

どちらも指定しなかった場合は true を返します。

絞り込み条件を変える

RDoc::Options#force_output=(val) (27304.0)

インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --force_output オプションと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。

@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。

RDoc::Options#force_update -> bool (27304.0)

インスタンスメソッド

コマンドライン引数の --force_update を指定していた場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --force_update を指定していた場合に true を返しま
す。そうでない場合は false を返します。

RDoc::Options#include_line_numbers -> bool (27304.0)

インスタンスメソッド

コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --include-line-numbers を指定していた場合に true
を返します。そうでない場合は false を返します。

RDoc::Options#inline_source -> bool (27304.0)

インスタンスメソッド

コマンドライン引数の --inline-source オプションか --one-file を指定していた場合、もしくは --fmt オプションに xml 指定した場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --inline-source オプションか --one-file を指定して
いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま
す。そうでない場合は false を返します。

RDoc::Options#promiscuous (27304.0)

インスタンスメソッド

コマンドライン引数の --promiscuous を指定していた場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --promiscuous を指定していた場合に true を返します。
そうでない場合は false を返します。

絞り込み条件を変える

RDoc::Options#static_path -> [String] (27304.0)

インスタンスメソッド

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返します。

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。

RDoc::Options#static_path=(vals) (27304.0)

インスタンスメソッド

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

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

@param vals パスを文字列の配列で指定します。

RDoc::Options#webcvs -> String | nil (27304.0)

インスタンスメソッド

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

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

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

RDoc::Options::DEPRECATED -> {String -> String} (27304.0)

定数

非推奨のオプションの一覧を返します。

RDoc::Stats#num_classes -> Integer (27304.0)

インスタンスメソッド

解析したクラスの数を返します。

絞り込み条件を変える

<< 1 2 3 ... > >>

別のキーワード

種類

クラス

モジュール

キーワード

検索結果

先頭5件

RDoc::DOT_DOC_FILENAME -> ".document" (69355.0)

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

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

RDoc::Parser::C (63052.0)

RDoc (60055.0)

RDoc::VERSION -> String (60055.0)

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

RDoc::GENERAL_MODIFIERS -> [String] (60007.0)

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

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

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

RDoc::RDoc (45232.0)

RDoc::Markup::ToRdoc (45052.0)

RDoc::Error (42007.0)

RDoc::RDoc#document(argv) -> nil (36358.0)

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

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

RDoc::TopLevel#find_local_symbol(name) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule | RDoc::AnyMethod | RDoc::Alias | RDoc::Attr | RDoc::Constant (29425.0)

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

RDoc::TopLevel.all_classes_and_modules -> [RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule] (28861.0)

RDoc::TopLevel.find_class_named(name) -> RDoc::NormalClass | RDoc::SingleClass | nil (28558.0)

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

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

RDoc::Context#constants -> [RDoc::Constant] (28003.0)

RDoc::Context#includes -> [RDoc::Include] (28003.0)

RDoc::Context#sections -> RDoc::Context::Section (28003.0)

RDoc::Markup::ToRdoc.new(markup = nil) -> RDoc::Markup::ToRdoc (27943.0)

RDoc::CodeObject#section -> RDoc::Context::Section (27907.0)

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

RDoc::Parser::Simple#scan -> RDoc::TopLevel (27739.0)

RDoc::Context#add_constant(const) -> () (27736.0)

RDoc::Context#add_include(an_include) -> () (27736.0)

RDoc::Context#each_constant {|c| ... } -> [RDoc::Constant] (27706.0)

RDoc::Context#each_attribute {|a| ... } -> [RDoc::Attr] (27703.0)

RDoc::Context#each_method {|m| ... } -> [RDoc::AnyMethod] (27703.0)

RDoc::Parser::C#scan -> RDoc::TopLevel (27691.0)

RDoc::Options#encoding -> Encoding (27652.0)

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

RDoc::Parser::Markdown#scan -> RDoc::TopLevel (27643.0)

RDoc::Parser::RD#scan -> RDoc::TopLevel (27643.0)

RDoc::Parser::Ruby#scan -> RDoc::TopLevel (27643.0)

RDoc::Context#current_section -> RDoc::Context::Section (27607.0)

RDoc::Context#find_enclosing_module_named(name) -> RDoc::NormalModule | nil (27607.0)

RDoc::Parser.can_parse(file_name) -> RDoc::Parser | nil (27607.0)

RDoc::CodeObject#comment=(comment) (27604.0)

RDoc::Context::Section#set_comment(comment) -> () (27604.0)

RDoc::Markup::Formatter#convert(content) -> () (27604.0)

RDoc::Parser::Simple#remove_private_comments(comment) -> String (27604.0)

RDoc::Context#unmatched_alias_lists=(val) (27502.0)

RDoc::CodeObject#start_doc -> () (27406.0)

RDoc::CodeObject#stop_doc -> () (27406.0)

RDoc::Markup#add_special(pattern, name) -> () (27376.0)

RDoc::Text#normalize_comment(text) -> String (27376.0)

RDoc::CodeObject (27358.0)

RDoc::CodeObject#remove_classes_and_modules -> () (27352.0)

RDoc::CodeObject#remove_methods_etc -> () (27352.0)

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

RDoc::Options::SPECIAL -> [String] (27352.0)

RDoc::CodeObject#document_children=(val) (27340.0)

RDoc::CodeObject#document_self=(val) (27340.0)

RDoc::CodeObject#section=(val) (27340.0)

RDoc::Markup#convert(str, formatter) -> object | "" (27340.0)

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

RDoc::CodeObject#document_children -> bool (27322.0)

RDoc::CodeObject#document_self -> bool (27322.0)

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

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

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

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

RDoc::CodeObject#documented? -> bool (27304.0)

RDoc::Context#find_local_symbol(symbol) (27304.0)

RDoc::Context#initialize_classes_and_modules -> () (27304.0)

RDoc::Context#initialize_methods_etc -> () (27304.0)