ライブラリ
- rake (1)
-
rake
/ rdoctask (20) -
rdoc
/ code _ object (18) -
rdoc
/ context (49) -
rdoc
/ generator / darkfish (2) -
rdoc
/ generator / json _ index (1) -
rdoc
/ generator / ri (2) -
rdoc
/ markdown (11) -
rdoc
/ markup (7) -
rdoc
/ markup / formatter (2) -
rdoc
/ parser (1) -
rdoc
/ parser / c (1) -
rdoc
/ parser / changelog (1) -
rdoc
/ parser / markdown (1) -
rdoc
/ parser / rd (1) -
rdoc
/ parser / ruby (1) -
rdoc
/ parser / simple (2) -
rdoc
/ rdoc (1) -
rdoc
/ stats (9) -
rdoc
/ text (8) -
rdoc
/ top _ level (10) -
rubygems
/ doc _ manager (5) -
rubygems
/ specification (7)
クラス
-
Gem
:: DocManager (5) -
Gem
:: Specification (7) -
RDoc
:: CodeObject (18) -
RDoc
:: Context (42) -
RDoc
:: Context :: Section (7) -
RDoc
:: Generator :: Darkfish (2) -
RDoc
:: Generator :: JsonIndex (1) -
RDoc
:: Generator :: RI (2) -
RDoc
:: Markdown (11) -
RDoc
:: Markup (7) -
RDoc
:: Markup :: Formatter (2) -
RDoc
:: Options (70) -
RDoc
:: Parser (1) -
RDoc
:: Parser :: C (1) -
RDoc
:: Parser :: ChangeLog (1) -
RDoc
:: Parser :: Markdown (1) -
RDoc
:: Parser :: RD (1) -
RDoc
:: Parser :: Ruby (1) -
RDoc
:: Parser :: Simple (2) -
RDoc
:: RDoc (1) -
RDoc
:: Stats (9) -
RDoc
:: TopLevel (10) -
Rake
:: RDocTask (20)
モジュール
-
Gem
:: InstallUpdateOptions (1) - Kernel (1)
-
RDoc
:: Text (8)
キーワード
- <=> (1)
- == (1)
-
add
_ alias (1) -
add
_ attribute (1) -
add
_ class (1) -
add
_ class _ or _ module (2) -
add
_ constant (1) -
add
_ html (1) -
add
_ include (1) -
add
_ method (1) -
add
_ module (1) -
add
_ require (1) -
add
_ special (1) -
add
_ tag (1) -
add
_ to (1) -
add
_ word _ pair (1) - aliases (1)
-
all
_ one _ file (1) -
attribute
_ manager (1) - attributes (1)
- charset (1)
- classes (1)
- comment (2)
- comment= (1)
- constants (1)
- content (1)
- convert (2)
-
coverage
_ report (1) -
coverage
_ report= (1) - css (1)
-
current
_ section (1) - define (1)
-
defined
_ in? (1) -
definition
_ lists (1) -
definition
_ lists= (1) - diagram (1)
- document (1)
-
document
_ children (1) -
document
_ children= (1) -
document
_ self (1) -
document
_ self= (1) - documented? (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)
- external (1)
- external= (1)
-
extra
_ accessor _ flags (1) -
extra
_ accessors (1) -
extra
_ rdoc _ files (1) -
extra
_ rdoc _ files= (1) -
file
_ absolute _ name (1) -
file
_ absolute _ name= (1) -
file
_ relative _ name (1) -
file
_ relative _ name= (1) -
file
_ stat (1) -
file
_ stat= (1) - fileboxes (1)
- files (1)
-
find
_ enclosing _ module _ named (1) -
find
_ local _ symbol (2) -
find
_ module _ named (2) -
find
_ symbol (1) -
finish
_ page _ dir (1) -
flush
_ left (1) -
force
_ output (1) -
force
_ output= (1) -
force
_ update (1) - formatter (1)
- formatter= (1)
-
full
_ name (1) - generate (3)
-
generate
_ rdoc (1) - generator (1)
- generator= (1)
-
get
_ line _ types (1) - github (1)
- github= (1)
-
has
_ rdoc (1) -
has
_ rdoc= (1) -
has
_ rdoc? (1) - html (1)
- html= (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)
-
install
_ rdoc (1) -
install
_ update _ defaults _ str (1) -
line
_ numbers (1) -
line
_ numbers= (1) - main (1)
- main= (1)
-
main
_ page (1) -
main
_ page= (1) - markup (2)
- markup= (1)
- merge (1)
-
method
_ list (1) - modules (1)
- multitask (1)
- name (2)
- name= (1)
-
normalize
_ comment (1) - notes (1)
- notes= (1)
-
num
_ classes (1) -
num
_ classes= (1) -
num
_ files (1) -
num
_ files= (1) -
num
_ methods (1) -
num
_ methods= (1) -
num
_ modules (1) -
num
_ modules= (1) -
ongoing
_ visibility= (1) -
op
_ dir (1) -
op
_ dir= (1) -
op
_ name (1) -
option
_ list (1) -
option
_ parser (1) -
option
_ parser= (1) -
option
_ string (1) -
page
_ dir (1) -
page
_ dir= (1) - parent (2)
- parent= (1)
-
parent
_ file _ name (1) -
parent
_ name (1) - parse (3)
-
parse
_ files _ matching (1) - pipe (1)
- pipe= (1)
- print (1)
- promiscuous (1)
- quiet (1)
- quote (1)
-
rdoc
_ dir (1) -
rdoc
_ dir= (1) -
rdoc
_ files (1) -
rdoc
_ files= (1) -
rdoc
_ include (1) -
rdoc
_ installed? (1) -
record
_ location (1) -
remove
_ classes _ and _ modules (1) -
remove
_ methods _ etc (1) -
remove
_ private _ comments (1) - requires (1)
- root (1)
- root= (1)
-
sanitize
_ path (1) - scan (6)
- section (1)
- section= (1)
- sections (1)
- sequence (1)
-
set
_ comment (1) -
set
_ current _ section (1) -
set
_ visibility _ for (1) -
setup
_ rdoc (1) -
show
_ all (1) -
show
_ all= (1) -
show
_ hash (1) -
start
_ doc (1) -
static
_ path (1) -
static
_ path= (1) -
stop
_ doc (1) -
strip
_ hashes (1) -
strip
_ newlines (1) -
strip
_ stars (1) -
tab
_ width (1) - template (2)
- template= (1)
-
template
_ dir (1) -
template
_ dir= (1) - title (3)
- title= (2)
- toplevel (1)
-
uninstall
_ doc (1) -
unmatched
_ alias _ lists (1) -
unmatched
_ alias _ lists= (1) - verbosity (1)
- verbosity= (1)
- visibility (2)
- visibility= (1)
- warn (1)
- webcvs (1)
検索結果
先頭5件
-
RDoc
:: Context :: Section # title -> String | nil (27304.0) -
section のタイトルを返します。
section のタイトルを返します。 -
RDoc
:: Generator :: Darkfish # generate -> () (27304.0) -
解析した情報を HTML ファイルや検索用のインデックスに出力します。
解析した情報を HTML ファイルや検索用のインデックスに出力します。 -
RDoc
:: Generator :: RI # generate -> () (27304.0) -
解析した情報を ri コマンドから読めるようにファイルに出力します。
解析した情報を ri コマンドから読めるようにファイルに出力します。 -
RDoc
:: Markdown # definition _ lists -> bool (27304.0) -
定義リストを解釈するかどうかを返します。
定義リストを解釈するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # definition _ lists=(val) (27304.0) -
定義リストを解釈するかどうかを設定します。
定義リストを解釈するかどうかを設定します。 -
RDoc
:: Markdown # extension(name , enable) -> () (27304.0) -
引数 name で指定した拡張の有効/無効を設定します。
引数 name で指定した拡張の有効/無効を設定します。
@param name 拡張の名前を Symbol で指定します。
@param enable 有効にする場合は true を、無効にする場合は false を指定し
ます。 -
RDoc
:: Markdown # extension?(name) (27304.0) -
引数 name で指定した拡張が有効かどうかを返します。
引数 name で指定した拡張が有効かどうかを返します。
@param name 拡張の名前を Symbol で指定します。 -
RDoc
:: Markdown # github -> bool (27304.0) -
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し ます。
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し
ます。
デフォルトでは true を返します。 -
RDoc
:: Markdown # github=(val) (27304.0) -
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定 します。
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定
します。 -
RDoc
:: Markdown # html -> bool (27304.0) -
HTML を記述した場合にそのまま出力するかどうかを返します。
HTML を記述した場合にそのまま出力するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # html=(val) (27304.0) -
HTML を記述した場合にそのまま出力するかどうかを設定します。
HTML を記述した場合にそのまま出力するかどうかを設定します。 -
RDoc
:: Markdown # notes -> bool (27304.0) -
脚注の出力を有効にするかどうかを返します。
脚注の出力を有効にするかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # notes=(val) (27304.0) -
脚注の出力を有効にするかどうかを設定します。
脚注の出力を有効にするかどうかを設定します。 -
RDoc
:: Markup # convert(str , formatter) -> object | "" (27304.0) -
str で指定された文字列を formatter に変換させます。
str で指定された文字列を formatter に変換させます。
@param str 変換する文字列を指定します。
@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。
変換結果は formatter によって文字列や配列を返します。 -
RDoc
:: Markup :: Formatter # convert(content) -> () (27304.0) -
content で指定された文字列を変換します。
content で指定された文字列を変換します。
@param content 変換する文字列を指定します。 -
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 # 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 # formatter -> nil (27304.0) -
使用されていません。常に nil を返します。
使用されていません。常に nil を返します。 -
RDoc
:: Options # formatter=(val) (27304.0) -
使用されていません。
使用されていません。 -
RDoc
:: Options # generator=(val) (27304.0) -
コマンドライン引数の --fmt オプションと同様の指定を行います。
コマンドライン引数の --fmt オプションと同様の指定を行います。
@param val 設定する Generator を指定します。 -
RDoc
:: Options # image _ format -> String (27304.0) -
コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。
コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。
指定しなかった場合は 'png' を返します。 -
RDoc
:: Options # quiet -> bool (27304.0) -
コマンドライン引数の --quiet オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
コマンドライン引数の --quiet オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。 -
RDoc
:: Options # root -> Pathname (27304.0) -
コマンドライン引数の --root オプションで指定したディレクトリを返します。
コマンドライン引数の --root オプションで指定したディレクトリを返します。
指定されていない場合はカレントディレクトリを返します。 -
RDoc
:: Options # root=(val) (27304.0) -
コマンドライン引数の --root オプションと同様の指定を行います。
コマンドライン引数の --root オプションと同様の指定を行います。
@param val パスを文字列で指定します。 -
RDoc
:: Options # tab _ width -> Integer (27304.0) -
コマンドライン引数の --tab-width オプションで指定した数値を返します。
コマンドライン引数の --tab-width オプションで指定した数値を返します。 -
RDoc
:: Options # verbosity -> 0 | 1 | 2 (27304.0) -
プログラムの解析時に表示する情報の詳細さを数値で返します。
プログラムの解析時に表示する情報の詳細さを数値で返します。
以下の値を指定する事ができます。
: 0(--quiet オプションを指定した場合)
情報を表示しません。
: 1
通常の表示を行います。
: 2(--verbose オプションを指定した場合)
詳細な情報を表示します。 -
RDoc
:: Options # visibility -> :public | :protected | :private (27304.0) -
コマンドライン引数の --visibility で指定したオプションを Symbol で返します。
コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。 -
RDoc
:: Options # visibility=(val) (27304.0) -
コマンドライン引数の --visibility オプションと同様の指定を行います。
コマンドライン引数の --visibility オプションと同様の指定を行います。
@param val :public、:protected、:private のいずれかを指定します。 -
RDoc
:: Parser :: Simple # remove _ private _ comments(comment) -> String (27304.0) -
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返 します。
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。
@param comment 対象の文字列を指定します。
@return コメントが削除された文字列を返します。 -
RDoc
:: Stats # num _ methods -> Integer (27304.0) -
解析したメソッドの数を返します。
解析したメソッドの数を返します。 -
RDoc
:: Stats # num _ methods=(val) (27304.0) -
解析したメソッドの数を指定します。
解析したメソッドの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # print -> () (27304.0) -
自身の持つ情報を標準出力に表示します。
自身の持つ情報を標準出力に表示します。 -
RDoc
:: Text # flush _ left(text) -> String (27304.0) -
引数から各行の行頭のスペースを削除します。
引数から各行の行頭のスペースを削除します。
@param text 文字列を指定します。 -
RDoc
:: TopLevel # file _ absolute _ name -> String (27304.0) -
自身が管理するファイルに関する絶対パスを文字列で返します。
自身が管理するファイルに関する絶対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ absolute _ name=(val) (27304.0) -
自身が管理するファイルに関する絶対パスを文字列で設定します。
自身が管理するファイルに関する絶対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ relative _ name -> String (27304.0) -
自身が管理するファイルに関する相対パスを文字列で返します。
自身が管理するファイルに関する相対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ relative _ name=(val) (27304.0) -
自身が管理するファイルに関する相対パスを文字列で設定します。
自身が管理するファイルに関する相対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ stat=(val) (27304.0) -
自身が管理するファイルに関する File::Stat オブジェクトを設定しま す。
自身が管理するファイルに関する File::Stat オブジェクトを設定しま
す。
@param val File::Stat オブジェクトを指定します。 -
Rake
:: RDocTask # quote(str) -> String (27304.0) -
Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。
Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。
@param str クオートする文字列を指定します。 -
RDoc
:: TopLevel # find _ local _ symbol(name) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule | RDoc :: AnyMethod | RDoc :: Alias | RDoc :: Attr | RDoc :: Constant (20425.0) -
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。 -
RDoc
:: Context # add _ class _ or _ module(collection , class _ type , name , superclass = nil) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule (19303.0) -
collection に name で指定したクラス、モジュールを追加します。
collection に name で指定したクラス、モジュールを追加します。
@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param su... -
RDoc
:: TopLevel # add _ class _ or _ module(collection , class _ type , name , superclass) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule (19303.0) -
collection に name で指定したクラス、モジュールを追加します。
collection に name で指定したクラス、モジュールを追加します。
@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param su... -
RDoc
:: Context # add _ module(class _ type , name) -> RDoc :: NormalModule | RDoc :: SingleClass | RDoc :: NormalClass (19285.0) -
引数で指定したモジュールを追加します。
引数で指定したモジュールを追加します。
ただし、クラスとして既に同名のものが登録されていた場合は、何もせずにそ
のクラスを返します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@see RDoc::Context#add_class -
RDoc
:: Context # add _ class(class _ type , name , superclass) -> RDoc :: SingleClass | RDoc :: NormalClass (18982.0) -
引数で指定したクラスを追加します。
引数で指定したクラスを追加します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass オ
ブジェクトで指定します。 -
RDoc
:: Context # each _ classmodule {|m| . . . } -> [RDoc :: SingleClass | RDoc :: NormalClass | RDoc :: NormalModule] (18949.0) -
追加されたクラス、モジュールに対してブロックを評価します。
追加されたクラス、モジュールに対してブロックを評価します。
@see RDoc::Context#classes, RDoc::Context#modules -
RDoc
:: Text # parse(text) -> RDoc :: Markup :: Document | Array (18673.0) -
引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。
引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。
@param text 文字列を指定します。
@see RDoc::Text#normalize_comment -
Kernel
# multitask(args) { . . . } -> Rake :: MultiTask (18622.0) -
事前タスクを並列実行するタスクを定義します。
事前タスクを並列実行するタスクを定義します。
与えられた事前タスクを実行する順序は不定です。
例:
multitask :deploy => [:deploy_gem, :deploy_rdoc] -
RDoc
:: Context # classes -> [RDoc :: SingleClass | RDoc :: NormalClass] (18610.0) -
追加されたクラスの配列を返します。
追加されたクラスの配列を返します。 -
RDoc
:: Context # add _ alias(an _ alias) -> RDoc :: Alias (18373.0) -
引数で指定した RDoc::Alias オブジェクトを追加します。
引数で指定した RDoc::Alias オブジェクトを追加します。
@param an_alias RDoc::Alias オブジェクトを指定します。 -
RDoc
:: Context # aliases -> [RDoc :: Alias] (18355.0) -
追加された RDoc::Alias の配列を返します。
追加された RDoc::Alias の配列を返します。 -
RDoc
:: Context # find _ module _ named(name) -> RDoc :: NormalModule | nil (18355.0) -
追加された RDoc::NormalModule から引数で指定した名前のモジュール を検索します。見つからなかった場合は nil を返します。
追加された RDoc::NormalModule から引数で指定した名前のモジュール
を検索します。見つからなかった場合は nil を返します。
@param name モジュールの名前を文字列で指定します。 -
RDoc
:: Context # includes -> [RDoc :: Include] (18355.0) -
追加された RDoc::Include の配列を返します。
追加された RDoc::Include の配列を返します。 -
RDoc
:: Context # modules -> [RDoc :: NormalModule] (18355.0) -
追加された RDoc::NormalModule の配列を返します。
追加された RDoc::NormalModule の配列を返します。 -
RDoc
:: Context # requires -> [RDoc :: Require] (18355.0) -
追加された RDoc::Require の配列を返します。
追加された RDoc::Require の配列を返します。 -
RDoc
:: TopLevel # find _ module _ named(name) -> RDoc :: NormalModule (18355.0) -
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。 見つからなかった場合は nil を返します。
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。
見つからなかった場合は nil を返します。
@param name モジュール名を文字列で指定します。 -
Gem
:: DocManager # uninstall _ doc (18352.0) -
RDoc と RI 用のデータを削除します。
RDoc と RI 用のデータを削除します。 -
Rake
:: RDocTask # name -> String (18352.0) -
タスクの名前を返します。デフォルトは rdoc です。
タスクの名前を返します。デフォルトは rdoc です。 -
RDoc
:: Context :: Section # ==(other) -> bool (18322.0) -
自身と other のシーケンス番号を比較した結果を返します。
自身と other のシーケンス番号を比較した結果を返します。
@param other RDoc::Context::Section オブジェクトを指定します。 -
RDoc
:: Options # markup -> String (18322.0) -
コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。
コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。
指定されていない場合は 'rdoc' を返します。 -
RDoc
:: Context # find _ enclosing _ module _ named(name) -> RDoc :: NormalModule | nil (18307.0) -
find a module at a higher scope
find a module at a higher scope -
RDoc
:: Context # <=>(other) -> -1 | 0 | 1 (18304.0) -
自身と other の full_name を比較した結果を返します。
自身と other の full_name を比較した結果を返します。
ソートのために使われます。
@param other 自身と比較したいオブジェクトを指定します。 -
RDoc
:: Context # find _ symbol(symbol , method=nil) (18304.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 # name -> String (18304.0) -
自身の名前を返します。
自身の名前を返します。
サブクラスによっては、メソッド名やクラス名を意味します。 -
RDoc
:: Context :: Section # sequence -> String (18304.0) -
section のシーケンス番号を文字列で返します。
section のシーケンス番号を文字列で返します。
リンクを作成する時に使われます。 -
RDoc
:: Options # css -> String (18304.0) -
コマンドライン引数の --style オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --style オプションで指定した URL を文字列で返しま
す。 -
RDoc
:: Options # files -> [String] (18304.0) -
解析するファイルの一覧を文字列の配列で返します。
解析するファイルの一覧を文字列の配列で返します。 -
RDoc
:: Options # main _ page -> String | nil (18304.0) -
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # merge -> true | nil (18304.0) -
コマンドライン引数の --merge オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
コマンドライン引数の --merge オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。 -
RDoc
:: Options # op _ dir -> String (18304.0) -
コマンドライン引数の --op オプションで指定したディレクトリを返します。
コマンドライン引数の --op オプションで指定したディレクトリを返します。
--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。
@return 設定されたディレクトリを文字列で返します。 -
RDoc
:: Options # op _ name -> String (18304.0) -
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま す。
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま
す。 -
RDoc
:: Options # page _ dir -> Pathname | nil (18304.0) -
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し ます。
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し
ます。
指定されていない場合は nil を返します。 -
RDoc
:: Options # webcvs -> String | nil (18304.0) -
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま
す。
指定しなかった場合は nil を返します。 -
RDoc
:: Stats # num _ classes -> Integer (18304.0) -
解析したクラスの数を返します。
解析したクラスの数を返します。 -
RDoc
:: Stats # num _ files -> Integer (18304.0) -
解析したファイルの数を返します。
解析したファイルの数を返します。 -
RDoc
:: Stats # num _ modules -> Integer (18304.0) -
解析したモジュールの数を返します。
解析したモジュールの数を返します。 -
RDoc
:: Text # markup(text) -> String (18304.0) -
引数を整形します。
引数を整形します。
include したクラスに self#formatter メソッドが必要です。
@param text 文字列を指定します。 -
RDoc
:: TopLevel # full _ name -> String (18304.0) -
自身が管理するファイルの名前を返します。
自身が管理するファイルの名前を返します。 -
Rake
:: RDocTask # main -> String (18304.0) -
メインとして使用されるファイル名を返します。
メインとして使用されるファイル名を返します。 -
RDoc
:: Context # add _ require(a _ require) -> () (18118.0) -
自身が所属する RDoc::TopLevel オブジェクトに引数で指定した RDoc::Require を追加します。
自身が所属する RDoc::TopLevel オブジェクトに引数で指定した
RDoc::Require を追加します。
@param a_require RDoc::Require オブジェクトを指定します。 -
RDoc
:: Context # add _ include(an _ include) -> () (18070.0) -
引数で指定した RDoc::Include オブジェクトを追加します。
引数で指定した RDoc::Include オブジェクトを追加します。
@param an_include RDoc::Include オブジェクトを指定します。 -
RDoc
:: CodeObject # remove _ classes _ and _ modules -> () (18052.0) -
何もしません。RDoc::CodeObject#document_children= に false を指定 した時のコールバックとして呼び出されます。オーバーライドして使用します。
何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。 -
RDoc
:: Context # defined _ in?(file) (18004.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 # find _ local _ symbol(symbol) (18004.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 # in _ files (18004.0) -
Files this context is found in
Files this context is found in -
RDoc
:: Options # all _ one _ file -> bool (18004.0) -
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。 -
RDoc
:: Options # diagram -> bool (18004.0) -
コマンドライン引数の --diagram オプションを指定していた場合、true を返 します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプションを指定していた場合、true を返
します。そうでない場合は false を返します。 -
RDoc
:: Options # dry _ run -> bool (18004.0) -
コマンドライン引数の --dry-run オプションを指定していた場合、true を返 します。--no-dry-run オプションを指定していた場合、false を返します。
コマンドライン引数の --dry-run オプションを指定していた場合、true を返
します。--no-dry-run オプションを指定していた場合、false を返します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # dry _ run=(val) (18004.0) -
val に true を指定した場合、コマンドライン引数の --dry-run オプションと 同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --dry-run オプションと
同様の指定を行います。
@param val --dry-run オプションと同じ指定を行う場合は true、そうでない
場合は false を指定します。 -
RDoc
:: Options # encoding -> Encoding (18004.0) -
コマンドライン引数の --encoding オプションを指定していた場合、指定した エンコーディングに対応する Encoding オブジェクトを返します。
コマンドライン引数の --encoding オプションを指定していた場合、指定した
エンコーディングに対応する Encoding オブジェクトを返します。
指定しなかった場合は Encoding.default_external の値を返します。 -
RDoc
:: Options # encoding=(val) (18004.0) -
コマンドライン引数の --encoding オプションと同様の指定を行います。
コマンドライン引数の --encoding オプションと同様の指定を行います。
@param val 設定する Encoding オブジェクトを指定します。 -
RDoc
:: Options # exclude -> Regexp (18004.0) -
コマンドライン引数の --exclude オプションで指定した正規表現を返します。 複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた ものを返します。
コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。 -
RDoc
:: Options # exclude=(val) (18004.0) -
コマンドライン引数の --exclude オプションと同様の指定を行います。
コマンドライン引数の --exclude オプションと同様の指定を行います。
@param val 設定するパターンを Regexp オブジェクトで指定します。 -
RDoc
:: Options # fileboxes -> bool (18004.0) -
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定 していた場合、true を返します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定
していた場合、true を返します。そうでない場合は false を返します。 -
RDoc
:: Options # finish _ page _ dir (18004.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: Options # hyperlink _ all -> bool (18004.0) -
コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。
コマンドライン引数の --hyperlink-all オプションを指定していた場合、
true を返します。
指定しなかった場合は false を返します。