クラス
-
RDoc
:: CodeObject (2) -
RDoc
:: Context (42) -
RDoc
:: Context :: Section (7) -
RDoc
:: Generator :: Darkfish (1) -
RDoc
:: Generator :: JsonIndex (1) -
RDoc
:: Generator :: RI (1) -
RDoc
:: Markdown (6) -
RDoc
:: Markup (2) -
RDoc
:: Markup :: Formatter (1) -
RDoc
:: Options (70) -
RDoc
:: TopLevel (2)
キーワード
- <=> (1)
- == (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) - 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 (1)
- 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)
-
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)
- 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 (27907.0) -
現在の section を返します。
現在の section を返します。 -
RDoc
:: Context # sections -> RDoc :: Context :: Section (27907.0) -
追加された RDoc::Context::Section の配列を返します。
...追加された RDoc::Context::Section の配列を返します。... -
RDoc
:: Context # add _ constant(const) -> () (27607.0) -
引数で指定した RDoc::Constant オブジェクトを追加します。
...引数で指定した RDoc::Constant オブジェクトを追加します。
@param const RDoc::Constant オブジェクトを指定します。... -
RDoc
:: Context # constants -> [RDoc :: Constant] (27607.0) -
追加された RDoc::Constant の配列を返します。
...追加された RDoc::Constant の配列を返します。... -
RDoc
:: Context # each _ constant {|c| . . . } -> [RDoc :: Constant] (27607.0) -
追加された RDoc::Constant に対してブロックを評価します。
...追加された RDoc::Constant に対してブロックを評価します。... -
RDoc
:: Options # option _ parser -> OptionParser | nil (27607.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。
コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。 -
RDoc
:: Context # ongoing _ visibility=(vis) (27307.0) -
Change the default visibility for new methods
Change the default visibility for new methods -
RDoc
:: Context # record _ location(toplevel) (27307.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) -> () (27307.0) -
Handle sections
Handle sections -
RDoc
:: Options # all _ one _ file -> bool (27307.0) -
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。 -
RDoc
:: Options # option _ parser=(val) (27307.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。
コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。
@param val OptionParser オブジェクトを指定します。 -
RDoc
:: Options # write _ options -> object (27307.0) -
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式 で保存します。
...カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式
で保存します。... -
RDoc
:: CodeObject # section -> RDoc :: Context :: Section (18907.0) -
所属している section を返します。
所属している section を返します。 -
RDoc
:: Markup :: Formatter # convert(content) -> () (18607.0) -
content で指定された文字列を変換します。
content で指定された文字列を変換します。
@param content 変換する文字列を指定します。 -
RDoc
:: Markdown # break _ on _ newline -> bool (18310.0) -
改行を保持した状態で出力するかどうかを返します。
改行を保持した状態で出力するかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # break _ on _ newline=(val) (18310.0) -
改行を保持した状態で出力するかどうかを設定します。
改行を保持した状態で出力するかどうかを設定します。 -
RDoc
:: CodeObject # section=(val) (18307.0) -
所属する section を設定します。
...所属する section を設定します。
@param val RDoc::Context::Section オブジェクトを指定します。... -
RDoc
:: Context :: Section # parent -> RDoc :: Context (18307.0) -
自身が所属する RDoc::Context オブジェクトを返します。
...自身が所属する RDoc::Context オブジェクトを返します。... -
RDoc
:: Markdown # definition _ lists -> bool (18307.0) -
定義リストを解釈するかどうかを返します。
定義リストを解釈するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # definition _ lists=(val) (18307.0) -
定義リストを解釈するかどうかを設定します。
定義リストを解釈するかどうかを設定します。 -
RDoc
:: Markdown # extension(name , enable) -> () (18307.0) -
引数 name で指定した拡張の有効/無効を設定します。
引数 name で指定した拡張の有効/無効を設定します。
@param name 拡張の名前を Symbol で指定します。
@param enable 有効にする場合は true を、無効にする場合は false を指定し
ます。 -
RDoc
:: Markdown # extension?(name) (18307.0) -
引数 name で指定した拡張が有効かどうかを返します。
引数 name で指定した拡張が有効かどうかを返します。
@param name 拡張の名前を Symbol で指定します。 -
RDoc
:: Markup # content -> String (18307.0) -
変換する文字列を返します。
...変換する文字列を返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる... -
RDoc
:: Markup # convert(str , formatter) -> object | "" (18307.0) -
str で指定された文字列を formatter に変換させます。
str で指定された文字列を formatter に変換させます。
@param str 変換する文字列を指定します。
@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。
変換結果は formatter によって文字列や配列を返します。 -
RDoc
:: Context :: Section # ==(other) -> bool (18007.0) -
自身と other のシーケンス番号を比較した結果を返します。
...自身と other のシーケンス番号を比較した結果を返します。
@param other RDoc::Context::Section オブジェクトを指定します。... -
RDoc
:: Context :: Section # comment -> String | nil (18007.0) -
section のコメントを返します。
section のコメントを返します。 -
RDoc
:: Context :: Section # inspect -> String (18007.0) -
自身の情報を人間に読みやすい文字列にして返します。
自身の情報を人間に読みやすい文字列にして返します。 -
RDoc
:: Context :: Section # sequence -> String (18007.0) -
section のシーケンス番号を文字列で返します。
section のシーケンス番号を文字列で返します。
リンクを作成する時に使われます。 -
RDoc
:: Context :: Section # set _ comment(comment) -> () (18007.0) -
自身にコメントを設定します。
自身にコメントを設定します。
@param comment 文字列を指定します。
comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。
# ---------------------
# :section: The title
# The body
# --------------------- -
RDoc
:: Context :: Section # title -> String | nil (18007.0) -
section のタイトルを返します。
section のタイトルを返します。 -
RDoc
:: Context # add _ class _ or _ module(collection , class _ type , name , superclass = nil) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule (9307.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) -> () (9307.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 # <=>(other) -> -1 | 0 | 1 (9007.0) -
自身と other の full_name を比較した結果を返します。
自身と other の full_name を比較した結果を返します。
ソートのために使われます。
@param other 自身と比較したいオブジェクトを指定します。 -
RDoc
:: Context # add _ alias(an _ alias) -> RDoc :: Alias (9007.0) -
引数で指定した RDoc::Alias オブジェクトを追加します。
...引数で指定した RDoc::Alias オブジェクトを追加します。
@param an_alias RDoc::Alias オブジェクトを指定します。... -
RDoc
:: Context # add _ attribute(an _ attribute) -> () (9007.0) -
引数で指定した RDoc::Attr オブジェクトを追加します。
...引数で指定した RDoc::Attr オブジェクトを追加します。
@param an_attribute RDoc::Attr オブジェクトを指定します。... -
RDoc
:: Context # add _ class(class _ type , name , superclass) -> RDoc :: SingleClass | RDoc :: NormalClass (9007.0) -
引数で指定したクラスを追加します。
...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass... -
RDoc
:: Context # add _ include(an _ include) -> () (9007.0) -
引数で指定した RDoc::Include オブジェクトを追加します。
...引数で指定した RDoc::Include オブジェクトを追加します。
@param an_include RDoc::Include オブジェクトを指定します。... -
RDoc
:: Context # add _ method(a _ method) -> () (9007.0) -
引数で指定した RDoc::AnyMethod オブジェクトを追加します。
...引数で指定した RDoc::AnyMethod オブジェクトを追加します。
@param a_method RDoc::AnyMethod オブジェクトかそのサブクラスのオ
ブジェクトを指定します。... -
RDoc
:: Context # add _ module(class _ type , name) -> RDoc :: NormalModule | RDoc :: SingleClass | RDoc :: NormalClass (9007.0) -
引数で指定したモジュールを追加します。
...ram class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@see RDoc::Context#add_class... -
RDoc
:: Context # add _ require(a _ require) -> () (9007.0) -
自身が所属する RDoc::TopLevel オブジェクトに引数で指定した RDoc::Require を追加します。
...自身が所属する RDoc::TopLevel オブジェクトに引数で指定した
RDoc::Require を追加します。
@param a_require RDoc::Require オブジェクトを指定します。... -
RDoc
:: Context # add _ to(array , thing) -> () (9007.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] (9007.0) -
追加された RDoc::Alias の配列を返します。
...追加された RDoc::Alias の配列を返します。... -
RDoc
:: Context # attributes -> [RDoc :: Attr] (9007.0) -
追加された RDoc::Attr の配列を返します。
...追加された RDoc::Attr の配列を返します。... -
RDoc
:: Context # classes -> [RDoc :: SingleClass | RDoc :: NormalClass] (9007.0) -
追加されたクラスの配列を返します。
追加されたクラスの配列を返します。 -
RDoc
:: Context # defined _ in?(file) (9007.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] (9007.0) -
追加された RDoc::Attr に対してブロックを評価します。
...追加された RDoc::Attr に対してブロックを評価します。... -
RDoc
:: Context # each _ classmodule {|m| . . . } -> [RDoc :: SingleClass | RDoc :: NormalClass | RDoc :: NormalModule] (9007.0) -
追加されたクラス、モジュールに対してブロックを評価します。
...追加されたクラス、モジュールに対してブロックを評価します。
@see RDoc::Context#classes, RDoc::Context#modules... -
RDoc
:: Context # each _ method {|m| . . . } -> [RDoc :: AnyMethod] (9007.0) -
追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト) に対してブロックを評価します。
...追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト)
に対してブロックを評価します。... -
RDoc
:: Context # find _ enclosing _ module _ named(name) -> RDoc :: NormalModule | nil (9007.0) -
find a module at a higher scope
find a module at a higher scope -
RDoc
:: Context # find _ local _ symbol(symbol) (9007.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 (9007.0) -
追加された RDoc::NormalModule から引数で指定した名前のモジュール を検索します。見つからなかった場合は nil を返します。
...追加された RDoc::NormalModule から引数で指定した名前のモジュール
を検索します。見つからなかった場合は nil を返します。
@param name モジュールの名前を文字列で指定します。... -
RDoc
:: Context # find _ symbol(symbol , method=nil) (9007.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 (9007.0) -
Files this context is found in
Files this context is found in -
RDoc
:: Context # includes -> [RDoc :: Include] (9007.0) -
追加された RDoc::Include の配列を返します。
...追加された RDoc::Include の配列を返します。... -
RDoc
:: Context # initialize _ classes _ and _ modules -> () (9007.0) -
追加されたクラスやモジュールをクリアします。
追加されたクラスやモジュールをクリアします。 -
RDoc
:: Context # initialize _ methods _ etc -> () (9007.0) -
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて いないものを含む)、require されたファイル、include されたファイル、定数 をクリアします。
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて
いないものを含む)、require されたファイル、include されたファイル、定数
をクリアします。 -
RDoc
:: Context # method _ list -> [RDoc :: AnyMethod] (9007.0) -
追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列 を返します。
...追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列
を返します。... -
RDoc
:: Context # modules -> [RDoc :: NormalModule] (9007.0) -
追加された RDoc::NormalModule の配列を返します。
...追加された RDoc::NormalModule の配列を返します。... -
RDoc
:: Context # name -> String (9007.0) -
自身の名前を返します。
自身の名前を返します。
サブクラスによっては、メソッド名やクラス名を意味します。 -
RDoc
:: Context # requires -> [RDoc :: Require] (9007.0) -
追加された RDoc::Require の配列を返します。
...追加された RDoc::Require の配列を返します。... -
RDoc
:: Context # toplevel -> RDoc :: TopLevel (9007.0) -
自身が所属する RDoc::TopLevel オブジェクトを返します。
...自身が所属する RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Context # unmatched _ alias _ lists -> {String => RDoc :: Alias} (9007.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。
...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。... -
RDoc
:: Context # unmatched _ alias _ lists=(val) (9007.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を設定します。
...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を設定します。
@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。... -
RDoc
:: Context # visibility -> :public | :protected | :private (9007.0) -
自身の可視性を Symbol で返します。
自身の可視性を Symbol で返します。 -
RDoc
:: Generator :: JsonIndex # generate -> () (9007.0) -
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出 力します。
...解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。... -
RDoc
:: Options # charset -> String (9007.0) -
コマンドライン引数の --charset オプションで指定した文字コードを文字列で 返します。
コマンドライン引数の --charset オプションで指定した文字コードを文字列で
返します。
指定しなかった場合は、$KCODE に応じた値になります。 -
RDoc
:: Options # coverage _ report -> Integer | false (9007.0) -
コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。
コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # coverage _ report=(val) (9007.0) -
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
@param val 数値オブジェクトか false を指定します。 -
RDoc
:: Options # css -> String (9007.0) -
コマンドライン引数の --style オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --style オプションで指定した URL を文字列で返しま
す。 -
RDoc
:: Options # diagram -> bool (9007.0) -
コマンドライン引数の --diagram オプションを指定していた場合、true を返 します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプションを指定していた場合、true を返
します。そうでない場合は false を返します。 -
RDoc
:: Options # dry _ run -> bool (9007.0) -
コマンドライン引数の --dry-run オプションを指定していた場合、true を返 します。--no-dry-run オプションを指定していた場合、false を返します。
コマンドライン引数の --dry-run オプションを指定していた場合、true を返
します。--no-dry-run オプションを指定していた場合、false を返します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # dry _ run=(val) (9007.0) -
val に true を指定した場合、コマンドライン引数の --dry-run オプションと 同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --dry-run オプションと
同様の指定を行います。
@param val --dry-run オプションと同じ指定を行う場合は true、そうでない
場合は false を指定します。 -
RDoc
:: Options # encoding -> Encoding (9007.0) -
コマンドライン引数の --encoding オプションを指定していた場合、指定した エンコーディングに対応する Encoding オブジェクトを返します。
コマンドライン引数の --encoding オプションを指定していた場合、指定した
エンコーディングに対応する Encoding オブジェクトを返します。
指定しなかった場合は Encoding.default_external の値を返します。 -
RDoc
:: Options # encoding=(val) (9007.0) -
コマンドライン引数の --encoding オプションと同様の指定を行います。
コマンドライン引数の --encoding オプションと同様の指定を行います。
@param val 設定する Encoding オブジェクトを指定します。 -
RDoc
:: Options # exclude -> Regexp (9007.0) -
コマンドライン引数の --exclude オプションで指定した正規表現を返します。 複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた ものを返します。
コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。 -
RDoc
:: Options # exclude=(val) (9007.0) -
コマンドライン引数の --exclude オプションと同様の指定を行います。
コマンドライン引数の --exclude オプションと同様の指定を行います。
@param val 設定するパターンを Regexp オブジェクトで指定します。 -
RDoc
:: Options # extra _ accessor _ flags -> {String => String} (9007.0) -
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。
値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。 -
RDoc
:: Options # extra _ accessors -> Regexp | nil (9007.0) -
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ てにマッチする正規表現オブジェクトを返します。
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # fileboxes -> bool (9007.0) -
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定 していた場合、true を返します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定
していた場合、true を返します。そうでない場合は false を返します。 -
RDoc
:: Options # files -> [String] (9007.0) -
解析するファイルの一覧を文字列の配列で返します。
解析するファイルの一覧を文字列の配列で返します。 -
RDoc
:: Options # finish _ page _ dir (9007.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: Options # force _ output -> bool (9007.0) -
コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返 します。
コマンドライン引数の --force_output オプションを指定していた場合、true
を返します。--no-force_output オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は true を返します。 -
RDoc
:: Options # force _ output=(val) (9007.0) -
val に true を指定した場合、コマンドライン引数の --force_output オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。
@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # force _ update -> bool (9007.0) -
コマンドライン引数の --force_update を指定していた場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --force_update を指定していた場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # formatter -> nil (9007.0) -
使用されていません。常に nil を返します。
使用されていません。常に nil を返します。 -
RDoc
:: Options # formatter=(val) (9007.0) -
使用されていません。
使用されていません。 -
RDoc
:: Options # generator -> Generator (9007.0) -
コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。
コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。
指定しなかった場合は、HTML に対応する Generator を返します。 -
RDoc
:: Options # generator=(val) (9007.0) -
コマンドライン引数の --fmt オプションと同様の指定を行います。
コマンドライン引数の --fmt オプションと同様の指定を行います。
@param val 設定する Generator を指定します。 -
RDoc
:: Options # hyperlink _ all -> bool (9007.0) -
コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。
コマンドライン引数の --hyperlink-all オプションを指定していた場合、
true を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # hyperlink _ all=(val) (9007.0) -
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ
ンと同様の指定を行います。
@param val --hyperlink-all オプションと同じ指定を行う場合は true、そう
でない場合は false を指定します。 -
RDoc
:: Options # image _ format -> String (9007.0) -
コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。
コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。
指定しなかった場合は 'png' を返します。 -
RDoc
:: Options # include _ line _ numbers -> bool (9007.0) -
コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。
コマンドライン引数の --include-line-numbers を指定していた場合に true
を返します。そうでない場合は false を返します。 -
RDoc
:: Options # inline _ source -> bool (9007.0) -
コマンドライン引数の --inline-source オプションか --one-file を指定して いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --inline-source オプションか --one-file を指定して
いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # line _ numbers -> bool (9007.0) -
コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返 します。
コマンドライン引数の --line-numbers オプションを指定していた場合、true
を返します。--no-line-numbers オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # line _ numbers=(val) (9007.0) -
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ
ンと同様の指定を行います。
@param val --line-numbers オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # main _ page -> String | nil (9007.0) -
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # main _ page=(val) (9007.0) -
コマンドライン引数の --main オプションと同様の指定を行います。
コマンドライン引数の --main オプションと同様の指定を行います。
@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。 -
RDoc
:: Options # markup -> String (9007.0) -
コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。
...コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。
指定されていない場合は 'rdoc' を返します。... -
RDoc
:: Options # markup=(val) (9007.0) -
コマンドライン引数の --markup オプションと同様の指定を行います。
コマンドライン引数の --markup オプションと同様の指定を行います。
@param val フォーマットを文字列で指定します。 -
RDoc
:: Options # merge -> true | nil (9007.0) -
コマンドライン引数の --merge オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
コマンドライン引数の --merge オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。