種類
- インスタンスメソッド (135)
- 定数 (11)
- 特異メソッド (11)
- クラス (6)
クラス
-
RDoc
:: CodeObject (2) -
RDoc
:: Context (45) -
RDoc
:: Context :: Section (8) -
RDoc
:: Generator :: Darkfish (2) -
RDoc
:: Generator :: JsonIndex (3) -
RDoc
:: Generator :: RI (2) -
RDoc
:: Markdown (10) -
RDoc
:: Markup (2) -
RDoc
:: Markup :: Formatter (1) -
RDoc
:: Markup :: ToHtmlCrossref (1) -
RDoc
:: Options (72) -
RDoc
:: Parser (2) -
RDoc
:: Parser :: C (1) -
RDoc
:: Parser :: Ruby (1) -
RDoc
:: Parser :: Simple (1) -
RDoc
:: TopLevel (2)
モジュール
- RDoc (2)
キーワード
- <=> (1)
- == (1)
- AnonClass (1)
-
CONSTANT
_ MODIFIERS (1) - Constant (1)
- Context (1)
-
DEFAULT
_ EXTENSIONS (1) - DEPRECATED (1)
- DESCRIPTION (1)
- EXTENSIONS (1)
- JsonIndex (1)
- Options (1)
-
SEARCH
_ INDEX _ FILE (1) - SPECIAL (1)
- Section (1)
- TYPES (1)
- VERSION (2)
- VISIBILITIES (1)
-
add
_ alias (1) -
add
_ attribute (1) -
add
_ class (1) -
add
_ class _ or _ module (2) -
add
_ constant (1) -
add
_ include (1) -
add
_ method (1) -
add
_ module (1) -
add
_ require (1) -
add
_ to (1) -
alias
_ extension (1) - aliases (1)
-
all
_ one _ file (1) - attributes (1)
-
break
_ on _ newline (1) -
break
_ on _ newline= (1) - charset (1)
- classes (1)
- comment (1)
- constants (1)
- content (1)
- convert (2)
-
coverage
_ report (1) -
coverage
_ report= (1) - css (1)
-
current
_ section (1) -
defined
_ in? (1) -
definition
_ lists (1) -
definition
_ lists= (1) - diagram (1)
-
dry
_ run (1) -
dry
_ run= (1) -
each
_ attribute (1) -
each
_ classmodule (1) -
each
_ constant (1) -
each
_ method (1) - encoding (1)
- encoding= (1)
- exclude (1)
- exclude= (1)
- extension (2)
- extension? (1)
-
extra
_ accessor _ flags (1) -
extra
_ accessors (1) - fileboxes (1)
- files (1)
-
find
_ enclosing _ module _ named (1) -
find
_ local _ symbol (2) -
find
_ module _ named (1) -
find
_ symbol (1) -
finish
_ page _ dir (1) -
force
_ output (1) -
force
_ output= (1) -
force
_ update (1) - formatter (1)
- formatter= (1)
- generate (1)
- generator (1)
- generator= (1)
-
hyperlink
_ all (1) -
hyperlink
_ all= (1) -
image
_ format (1) -
in
_ files (1) -
include
_ line _ numbers (1) - includes (1)
- initialize (2)
-
initialize
_ classes _ and _ modules (1) -
initialize
_ methods _ etc (1) -
inline
_ source (1) - inspect (1)
-
line
_ numbers (1) -
line
_ numbers= (1) -
main
_ page (1) -
main
_ page= (1) - markup (1)
- markup= (1)
- merge (1)
-
method
_ list (1) - modules (1)
- name (1)
- new (8)
-
ongoing
_ visibility= (1) -
op
_ dir (1) -
op
_ dir= (1) -
op
_ name (1) -
option
_ parser (1) -
option
_ parser= (1) -
page
_ dir (1) -
page
_ dir= (1) - parent (1)
- parse (1)
-
parser
_ for (1) - pipe (1)
- pipe= (1)
- promiscuous (1)
- quiet (1)
-
rdoc
_ include (1) -
record
_ location (1) - requires (1)
- root (1)
- root= (1)
-
sanitize
_ path (1) - section (1)
- section= (1)
- sections (1)
- sequence (1)
-
set
_ comment (1) -
set
_ current _ section (1) -
set
_ visibility _ for (1) -
show
_ all (1) -
show
_ all= (1) -
show
_ hash (1) -
static
_ path (1) -
static
_ path= (1) -
tab
_ width (1) - template (1)
-
template
_ dir (1) -
template
_ dir= (1) - title (2)
- title= (1)
- toplevel (1)
-
unmatched
_ alias _ lists (1) -
unmatched
_ alias _ lists= (1) - verbosity (1)
- verbosity= (1)
- visibility (2)
- visibility= (1)
- warn (1)
- webcvs (1)
検索結果
先頭5件
-
RDoc
:: Context # current _ section -> RDoc :: Context :: Section (27904.0) -
現在の section を返します。
現在の section を返します。 -
RDoc
:: Context # sections -> RDoc :: Context :: Section (27904.0) -
追加された RDoc::Context::Section の配列を返します。
...追加された RDoc::Context::Section の配列を返します。... -
RDoc
:: Context # add _ constant(const) -> () (27604.0) -
引数で指定した RDoc::Constant オブジェクトを追加します。
...引数で指定した RDoc::Constant オブジェクトを追加します。
@param const RDoc::Constant オブジェクトを指定します。... -
RDoc
:: Context # constants -> [RDoc :: Constant] (27604.0) -
追加された RDoc::Constant の配列を返します。
...追加された RDoc::Constant の配列を返します。... -
RDoc
:: Context # each _ constant {|c| . . . } -> [RDoc :: Constant] (27604.0) -
追加された RDoc::Constant に対してブロックを評価します。
...追加された RDoc::Constant に対してブロックを評価します。... -
RDoc
:: Options # option _ parser -> OptionParser | nil (27604.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。
コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。 -
RDoc
:: Context # ongoing _ visibility=(vis) (27304.0) -
Change the default visibility for new methods
Change the default visibility for new methods -
RDoc
:: Context # record _ location(toplevel) (27304.0) -
Record the file that we happen to find it in
Record the file that we happen to find it in -
RDoc
:: Context # set _ current _ section(title , comment) -> () (27304.0) -
Handle sections
Handle sections -
RDoc
:: Options # all _ one _ file -> bool (27304.0) -
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。 -
RDoc
:: Options # option _ parser=(val) (27304.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。
コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。
@param val OptionParser オブジェクトを指定します。 -
RDoc
:: Options # write _ options -> object (27304.0) -
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式 で保存します。
...カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式
で保存します。... -
RDoc
:: Context :: Section (27004.0) -
section に関する情報を保持するクラスです。
section に関する情報を保持するクラスです。
ドキュメント中で以下のように記述した情報を保持しています。
# :section: The title
# The body -
RDoc
:: CodeObject # section -> RDoc :: Context :: Section (18904.0) -
所属している section を返します。
所属している section を返します。 -
RDoc
:: Context :: Section . new(parent , title , comment) -> RDoc :: Context :: Section (18604.0) -
自身を初期化します。
...自身を初期化します。
@param parent RDoc::Context オブジェクトを指定します。
@param title section のタイトルを文字列で指定します。
@param comment section のコメントを文字列で指定します。
また、section のシーケンス番号を新しく... -
RDoc
:: Markup :: Formatter # convert(content) -> () (18604.0) -
content で指定された文字列を変換します。
content で指定された文字列を変換します。
@param content 変換する文字列を指定します。 -
RDoc
:: CONSTANT _ MODIFIERS -> [String] (18307.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: Markdown # break _ on _ newline -> bool (18307.0) -
改行を保持した状態で出力するかどうかを返します。
改行を保持した状態で出力するかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # break _ on _ newline=(val) (18307.0) -
改行を保持した状態で出力するかどうかを設定します。
改行を保持した状態で出力するかどうかを設定します。 -
RDoc
:: VERSION -> String (18307.0) -
RDoc のバージョンを表す文字列を返します。
...
RDoc のバージョンを表す文字列を返します。... -
RDoc
:: CodeObject # section=(val) (18304.0) -
所属する section を設定します。
...所属する section を設定します。
@param val RDoc::Context::Section オブジェクトを指定します。... -
RDoc
:: Context :: Section # parent -> RDoc :: Context (18304.0) -
自身が所属する RDoc::Context オブジェクトを返します。
...自身が所属する RDoc::Context オブジェクトを返します。... -
RDoc
:: Generator :: Darkfish :: VERSION -> & # 39;3& # 39; (18304.0) -
darkfish のバージョンです。
darkfish のバージョンです。 -
RDoc
:: Generator :: RI :: DESCRIPTION -> String (18304.0) -
このジェネレータの説明を表す文字列です。
このジェネレータの説明を表す文字列です。 -
RDoc
:: Markdown # definition _ lists -> bool (18304.0) -
定義リストを解釈するかどうかを返します。
定義リストを解釈するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # definition _ lists=(val) (18304.0) -
定義リストを解釈するかどうかを設定します。
定義リストを解釈するかどうかを設定します。 -
RDoc
:: Markdown # extension(name , enable) -> () (18304.0) -
引数 name で指定した拡張の有効/無効を設定します。
引数 name で指定した拡張の有効/無効を設定します。
@param name 拡張の名前を Symbol で指定します。
@param enable 有効にする場合は true を、無効にする場合は false を指定し
ます。 -
RDoc
:: Markdown # extension?(name) (18304.0) -
引数 name で指定した拡張が有効かどうかを返します。
引数 name で指定した拡張が有効かどうかを返します。
@param name 拡張の名前を Symbol で指定します。 -
RDoc
:: Markdown . extension(name) -> nil (18304.0) -
引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定 義します。
引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定
義します。
ライブラリ内部で使用します。 -
RDoc
:: Markdown :: DEFAULT _ EXTENSIONS -> [Symbol] (18304.0) -
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。 -
RDoc
:: Markdown :: EXTENSIONS -> [Symbol] (18304.0) -
サポートする拡張の一覧を Symbol の配列で返します。
サポートする拡張の一覧を Symbol の配列で返します。 -
RDoc
:: Markup # content -> String (18304.0) -
変換する文字列を返します。
...変換する文字列を返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる... -
RDoc
:: Markup # convert(str , formatter) -> object | "" (18304.0) -
str で指定された文字列を formatter に変換させます。
str で指定された文字列を formatter に変換させます。
@param str 変換する文字列を指定します。
@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。
変換結果は formatter によって文字列や配列を返します。 -
RDoc
:: Parser . alias _ extension(old _ ext , new _ ext) -> bool (18304.0) -
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登 録します。
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登
録します。
@param old_ext 拡張子を文字列で指定します。
@param new_ext 拡張子を文字列で指定します。
@return エイリアスが登録された場合は true を返します。old_ext にパーサ
が登録されていない場合、エイリアスが登録されずに false を返しま
す。 -
RDoc
:: Options (18022.0) -
rdoc コマンドのオプションを解析するためのクラスです。
...rdoc コマンドのオプションを解析するためのクラスです。
それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。
===[a:custom_options] カスタムオプション
RDoc のジェネレータでは、RDoc::Options をフックし......まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要があります。rdoc --help を実行する......ます。
例:
class RDoc::Generator::Spellcheck
RDoc::RDoc.add_generator self
def self.setup_options rdoc_options
op = rdoc_options.option_parser
op.on('--spell-dictionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_dicti... -
RDoc
:: AnonClass (18004.0) -
匿名クラスを表現するクラスです。
匿名クラスを表現するクラスです。
現在は使用されていません。 -
RDoc
:: Constant (18004.0) -
定数を表現するクラスです。
定数を表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: Context (18004.0) -
モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す るクラスを管理するクラスです。
...モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す
るクラスを管理するクラスです。... -
RDoc
:: Context :: Section # ==(other) -> bool (18004.0) -
自身と other のシーケンス番号を比較した結果を返します。
...自身と other のシーケンス番号を比較した結果を返します。
@param other RDoc::Context::Section オブジェクトを指定します。... -
RDoc
:: Context :: Section # comment -> String | nil (18004.0) -
section のコメントを返します。
section のコメントを返します。 -
RDoc
:: Context :: Section # inspect -> String (18004.0) -
自身の情報を人間に読みやすい文字列にして返します。
自身の情報を人間に読みやすい文字列にして返します。 -
RDoc
:: Context :: Section # sequence -> String (18004.0) -
section のシーケンス番号を文字列で返します。
section のシーケンス番号を文字列で返します。
リンクを作成する時に使われます。 -
RDoc
:: Context :: Section # set _ comment(comment) -> () (18004.0) -
自身にコメントを設定します。
自身にコメントを設定します。
@param comment 文字列を指定します。
comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。
# ---------------------
# :section: The title
# The body
# --------------------- -
RDoc
:: Context :: Section # title -> String | nil (18004.0) -
section のタイトルを返します。
section のタイトルを返します。 -
RDoc
:: Generator :: JsonIndex (18004.0) -
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ クスを生成するクラスです。
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するクラスです。 -
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
:: Context # add _ class _ or _ module(collection , class _ type , name , superclass = nil) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule (9304.0) -
collection に name で指定したクラス、モジュールを追加します。
...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass......オ
ブジェクトで指定します。
既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。... -
RDoc
:: Context # set _ visibility _ for(methods , visibility , singleton = false) -> () (9304.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 . new -> RDoc :: Context (9304.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Context # <=>(other) -> -1 | 0 | 1 (9004.0) -
自身と other の full_name を比較した結果を返します。
自身と other の full_name を比較した結果を返します。
ソートのために使われます。
@param other 自身と比較したいオブジェクトを指定します。 -
RDoc
:: Context # add _ alias(an _ alias) -> RDoc :: Alias (9004.0) -
引数で指定した RDoc::Alias オブジェクトを追加します。
...引数で指定した RDoc::Alias オブジェクトを追加します。
@param an_alias RDoc::Alias オブジェクトを指定します。... -
RDoc
:: Context # add _ attribute(an _ attribute) -> () (9004.0) -
引数で指定した RDoc::Attr オブジェクトを追加します。
...引数で指定した RDoc::Attr オブジェクトを追加します。
@param an_attribute RDoc::Attr オブジェクトを指定します。... -
RDoc
:: Context # add _ class(class _ type , name , superclass) -> RDoc :: SingleClass | RDoc :: NormalClass (9004.0) -
引数で指定したクラスを追加します。
...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass... -
RDoc
:: Context # add _ include(an _ include) -> () (9004.0) -
引数で指定した RDoc::Include オブジェクトを追加します。
...引数で指定した RDoc::Include オブジェクトを追加します。
@param an_include RDoc::Include オブジェクトを指定します。... -
RDoc
:: Context # add _ method(a _ method) -> () (9004.0) -
引数で指定した RDoc::AnyMethod オブジェクトを追加します。
...引数で指定した RDoc::AnyMethod オブジェクトを追加します。
@param a_method RDoc::AnyMethod オブジェクトかそのサブクラスのオ
ブジェクトを指定します。... -
RDoc
:: Context # add _ module(class _ type , name) -> RDoc :: NormalModule | RDoc :: SingleClass | RDoc :: NormalClass (9004.0) -
引数で指定したモジュールを追加します。
...ram class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@see RDoc::Context#add_class... -
RDoc
:: Context # add _ require(a _ require) -> () (9004.0) -
自身が所属する RDoc::TopLevel オブジェクトに引数で指定した RDoc::Require を追加します。
...自身が所属する RDoc::TopLevel オブジェクトに引数で指定した
RDoc::Require を追加します。
@param a_require RDoc::Require オブジェクトを指定します。... -
RDoc
:: Context # add _ to(array , thing) -> () (9004.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 # aliases -> [RDoc :: Alias] (9004.0) -
追加された RDoc::Alias の配列を返します。
...追加された RDoc::Alias の配列を返します。... -
RDoc
:: Context # attributes -> [RDoc :: Attr] (9004.0) -
追加された RDoc::Attr の配列を返します。
...追加された RDoc::Attr の配列を返します。... -
RDoc
:: Context # classes -> [RDoc :: SingleClass | RDoc :: NormalClass] (9004.0) -
追加されたクラスの配列を返します。
追加されたクラスの配列を返します。 -
RDoc
:: Context # defined _ in?(file) (9004.0) -
Return true if at least part of this thing was defined in file
Return true if at least part of this thing was defined in file -
RDoc
:: Context # each _ attribute {|a| . . . } -> [RDoc :: Attr] (9004.0) -
追加された RDoc::Attr に対してブロックを評価します。
...追加された RDoc::Attr に対してブロックを評価します。... -
RDoc
:: Context # each _ classmodule {|m| . . . } -> [RDoc :: SingleClass | RDoc :: NormalClass | RDoc :: NormalModule] (9004.0) -
追加されたクラス、モジュールに対してブロックを評価します。
...追加されたクラス、モジュールに対してブロックを評価します。
@see RDoc::Context#classes, RDoc::Context#modules... -
RDoc
:: Context # each _ method {|m| . . . } -> [RDoc :: AnyMethod] (9004.0) -
追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト) に対してブロックを評価します。
...追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト)
に対してブロックを評価します。... -
RDoc
:: Context # find _ enclosing _ module _ named(name) -> RDoc :: NormalModule | nil (9004.0) -
find a module at a higher scope
find a module at a higher scope -
RDoc
:: Context # find _ local _ symbol(symbol) (9004.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 # find _ module _ named(name) -> RDoc :: NormalModule | nil (9004.0) -
追加された RDoc::NormalModule から引数で指定した名前のモジュール を検索します。見つからなかった場合は nil を返します。
...追加された RDoc::NormalModule から引数で指定した名前のモジュール
を検索します。見つからなかった場合は nil を返します。
@param name モジュールの名前を文字列で指定します。... -
RDoc
:: Context # find _ symbol(symbol , method=nil) (9004.0) -
Look up the given symbol. If method is non-nil, then we assume the symbol references a module that contains that method
Look up the given symbol. If method is non-nil, then we assume
the symbol references a module that contains that method -
RDoc
:: Context # in _ files (9004.0) -
Files this context is found in
Files this context is found in -
RDoc
:: Context # includes -> [RDoc :: Include] (9004.0) -
追加された RDoc::Include の配列を返します。
...追加された RDoc::Include の配列を返します。... -
RDoc
:: Context # initialize _ classes _ and _ modules -> () (9004.0) -
追加されたクラスやモジュールをクリアします。
追加されたクラスやモジュールをクリアします。 -
RDoc
:: Context # initialize _ methods _ etc -> () (9004.0) -
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて いないものを含む)、require されたファイル、include されたファイル、定数 をクリアします。
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて
いないものを含む)、require されたファイル、include されたファイル、定数
をクリアします。 -
RDoc
:: Context # method _ list -> [RDoc :: AnyMethod] (9004.0) -
追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列 を返します。
...追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列
を返します。... -
RDoc
:: Context # modules -> [RDoc :: NormalModule] (9004.0) -
追加された RDoc::NormalModule の配列を返します。
...追加された RDoc::NormalModule の配列を返します。... -
RDoc
:: Context # name -> String (9004.0) -
自身の名前を返します。
自身の名前を返します。
サブクラスによっては、メソッド名やクラス名を意味します。 -
RDoc
:: Context # requires -> [RDoc :: Require] (9004.0) -
追加された RDoc::Require の配列を返します。
...追加された RDoc::Require の配列を返します。... -
RDoc
:: Context # toplevel -> RDoc :: TopLevel (9004.0) -
自身が所属する RDoc::TopLevel オブジェクトを返します。
...自身が所属する RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Context # unmatched _ alias _ lists -> {String => RDoc :: Alias} (9004.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。
...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。... -
RDoc
:: Context # unmatched _ alias _ lists=(val) (9004.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を設定します。
...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を設定します。
@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。... -
RDoc
:: Context # visibility -> :public | :protected | :private (9004.0) -
自身の可視性を Symbol で返します。
自身の可視性を Symbol で返します。 -
RDoc
:: Context :: TYPES -> ["class" , "instance"] (9004.0) -
メソッドの種類を文字列の配列で返します。
メソッドの種類を文字列の配列で返します。 -
RDoc
:: Context :: VISIBILITIES -> [:public , :protected , :private] (9004.0) -
メソッドの可視性を Symbol の配列で返します。
メソッドの可視性を Symbol の配列で返します。 -
RDoc
:: Generator :: JsonIndex # generate -> () (9004.0) -
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出 力します。
...解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。... -
RDoc
:: Generator :: JsonIndex :: SEARCH _ INDEX _ FILE -> String (9004.0) -
検索インデックスのパスを表す文字列です。
検索インデックスのパスを表す文字列です。 -
RDoc
:: Options # charset -> String (9004.0) -
コマンドライン引数の --charset オプションで指定した文字コードを文字列で 返します。
コマンドライン引数の --charset オプションで指定した文字コードを文字列で
返します。
指定しなかった場合は、$KCODE に応じた値になります。 -
RDoc
:: Options # coverage _ report -> Integer | false (9004.0) -
コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。
コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # coverage _ report=(val) (9004.0) -
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
@param val 数値オブジェクトか false を指定します。 -
RDoc
:: Options # css -> String (9004.0) -
コマンドライン引数の --style オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --style オプションで指定した URL を文字列で返しま
す。 -
RDoc
:: Options # diagram -> bool (9004.0) -
コマンドライン引数の --diagram オプションを指定していた場合、true を返 します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプションを指定していた場合、true を返
します。そうでない場合は false を返します。 -
RDoc
:: Options # dry _ run -> bool (9004.0) -
コマンドライン引数の --dry-run オプションを指定していた場合、true を返 します。--no-dry-run オプションを指定していた場合、false を返します。
コマンドライン引数の --dry-run オプションを指定していた場合、true を返
します。--no-dry-run オプションを指定していた場合、false を返します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # dry _ run=(val) (9004.0) -
val に true を指定した場合、コマンドライン引数の --dry-run オプションと 同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --dry-run オプションと
同様の指定を行います。
@param val --dry-run オプションと同じ指定を行う場合は true、そうでない
場合は false を指定します。 -
RDoc
:: Options # encoding -> Encoding (9004.0) -
コマンドライン引数の --encoding オプションを指定していた場合、指定した エンコーディングに対応する Encoding オブジェクトを返します。
コマンドライン引数の --encoding オプションを指定していた場合、指定した
エンコーディングに対応する Encoding オブジェクトを返します。
指定しなかった場合は Encoding.default_external の値を返します。 -
RDoc
:: Options # encoding=(val) (9004.0) -
コマンドライン引数の --encoding オプションと同様の指定を行います。
コマンドライン引数の --encoding オプションと同様の指定を行います。
@param val 設定する Encoding オブジェクトを指定します。 -
RDoc
:: Options # exclude -> Regexp (9004.0) -
コマンドライン引数の --exclude オプションで指定した正規表現を返します。 複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた ものを返します。
コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。 -
RDoc
:: Options # exclude=(val) (9004.0) -
コマンドライン引数の --exclude オプションと同様の指定を行います。
コマンドライン引数の --exclude オプションと同様の指定を行います。
@param val 設定するパターンを Regexp オブジェクトで指定します。 -
RDoc
:: Options # extra _ accessor _ flags -> {String => String} (9004.0) -
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。
値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。 -
RDoc
:: Options # extra _ accessors -> Regexp | nil (9004.0) -
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ てにマッチする正規表現オブジェクトを返します。
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # fileboxes -> bool (9004.0) -
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定 していた場合、true を返します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定
していた場合、true を返します。そうでない場合は false を返します。 -
RDoc
:: Options # files -> [String] (9004.0) -
解析するファイルの一覧を文字列の配列で返します。
解析するファイルの一覧を文字列の配列で返します。