クラス
-
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)
モジュール
-
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) -
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)
-
extra
_ accessor _ flags (1) -
extra
_ accessors (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)
- generator (1)
- generator= (1)
-
get
_ line _ types (1) - github (1)
- github= (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)
-
line
_ numbers (1) -
line
_ numbers= (1) -
main
_ page (1) -
main
_ page= (1) - markup (2)
- markup= (1)
- merge (1)
-
method
_ list (1) - modules (1)
- 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
_ parser (1) -
option
_ parser= (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)
-
rdoc
_ include (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) -
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 (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
:: Options # verbosity=(val) (18307.0) -
プログラムの解析時に表示する情報の詳細さを数値で指定します。
...プログラムの解析時に表示する情報の詳細さを数値で指定します。
@param val 何も表示しない場合は 0、通常の表示を行う場合は 1、詳細な表示
を行う場合は 2 を指定します。
@see RDoc::Options#verbosity... -
RDoc
:: Options # visibility -> :public | :protected | :private (18307.0) -
コマンドライン引数の --visibility で指定したオプションを Symbol で返します。
コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。 -
RDoc
:: Options # visibility=(val) (18307.0) -
コマンドライン引数の --visibility オプションと同様の指定を行います。
コマンドライン引数の --visibility オプションと同様の指定を行います。
@param val :public、:protected、:private のいずれかを指定します。 -
RDoc
:: Parser # parse _ files _ matching(regexp) -> () (18307.0) -
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。
...マッチするファイルを解析できるパーサとして、
自身を登録します。
@param regexp 正規表現を指定します。
新しいパーサを作成する時に使用します。
例:
class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end... -
RDoc
:: Parser :: Simple # remove _ private _ comments(comment) -> String (18307.0) -
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返 します。
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。
@param comment 対象の文字列を指定します。
@return コメントが削除された文字列を返します。 -
RDoc
:: RDoc # document(argv) -> nil (18307.0) -
argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。
...ドラインで rdoc コマンドに指定するのと同じ引数を文字
列の配列で指定します。
@raise RDoc::Error ドキュメントの処理中にエラーがあった場合に発生します。
指定できるオプションについては、lib:rdoc#usage を参照し... -
RDoc
:: Stats # num _ methods -> Integer (18307.0) -
解析したメソッドの数を返します。
解析したメソッドの数を返します。 -
RDoc
:: Stats # num _ methods=(val) (18307.0) -
解析したメソッドの数を指定します。
解析したメソッドの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # print -> () (18307.0) -
自身の持つ情報を標準出力に表示します。
自身の持つ情報を標準出力に表示します。 -
RDoc
:: Text # flush _ left(text) -> String (18307.0) -
引数から各行の行頭のスペースを削除します。
引数から各行の行頭のスペースを削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # normalize _ comment(text) -> String (18307.0) -
引数から行頭のスペースや改行文字などを削除します。
...から行頭のスペースや改行文字などを削除します。
詳しくは [SEE ALSO] の各メソッドを参照してください。
@param text 文字列を指定します。
@see RDoc::Text#strip_hashes, RDoc::Text#expand_tabs,
RDoc::Text#flush_left, RDoc::Text#strip_newlines... -
RDoc
:: TopLevel # file _ absolute _ name -> String (18307.0) -
自身が管理するファイルに関する絶対パスを文字列で返します。
自身が管理するファイルに関する絶対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ absolute _ name=(val) (18307.0) -
自身が管理するファイルに関する絶対パスを文字列で設定します。
自身が管理するファイルに関する絶対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ relative _ name -> String (18307.0) -
自身が管理するファイルに関する相対パスを文字列で返します。
自身が管理するファイルに関する相対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ relative _ name=(val) (18307.0) -
自身が管理するファイルに関する相対パスを文字列で設定します。
自身が管理するファイルに関する相対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ stat=(val) (18307.0) -
自身が管理するファイルに関する File::Stat オブジェクトを設定しま す。
自身が管理するファイルに関する File::Stat オブジェクトを設定しま
す。
@param val File::Stat オブジェクトを指定します。 -
RDoc
:: Context # <=>(other) -> -1 | 0 | 1 (9307.0) -
自身と other の full_name を比較した結果を返します。
自身と other の full_name を比較した結果を返します。
ソートのために使われます。
@param other 自身と比較したいオブジェクトを指定します。 -
RDoc
:: Context # add _ class(class _ type , name , superclass) -> RDoc :: SingleClass | RDoc :: NormalClass (9307.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 (9307.0) -
collection に name で指定したクラス、モジュールを追加します。
...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass......オ
ブジェクトで指定します。
既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。... -
RDoc
:: Context # add _ module(class _ type , name) -> RDoc :: NormalModule | RDoc :: SingleClass | RDoc :: NormalClass (9307.0) -
引数で指定したモジュールを追加します。
...ram class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@see RDoc::Context#add_class... -
RDoc
:: Context # find _ symbol(symbol , method=nil) (9307.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 (9307.0) -
自身の名前を返します。
自身の名前を返します。
サブクラスによっては、メソッド名やクラス名を意味します。 -
RDoc
:: Context :: Section # ==(other) -> bool (9307.0) -
自身と other のシーケンス番号を比較した結果を返します。
...自身と other のシーケンス番号を比較した結果を返します。
@param other RDoc::Context::Section オブジェクトを指定します。... -
RDoc
:: Context :: Section # sequence -> String (9307.0) -
section のシーケンス番号を文字列で返します。
section のシーケンス番号を文字列で返します。
リンクを作成する時に使われます。 -
RDoc
:: Options # css -> String (9307.0) -
コマンドライン引数の --style オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --style オプションで指定した URL を文字列で返しま
す。 -
RDoc
:: Options # files -> [String] (9307.0) -
解析するファイルの一覧を文字列の配列で返します。
解析するファイルの一覧を文字列の配列で返します。 -
RDoc
:: Options # main _ page -> String | nil (9307.0) -
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # markup -> String (9307.0) -
コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。
...コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。
指定されていない場合は 'rdoc' を返します。... -
RDoc
:: Options # merge -> true | nil (9307.0) -
コマンドライン引数の --merge オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
コマンドライン引数の --merge オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。 -
RDoc
:: Options # op _ dir -> String (9307.0) -
コマンドライン引数の --op オプションで指定したディレクトリを返します。
コマンドライン引数の --op オプションで指定したディレクトリを返します。
--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。
@return 設定されたディレクトリを文字列で返します。 -
RDoc
:: Options # op _ name -> String (9307.0) -
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま す。
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま
す。 -
RDoc
:: Options # page _ dir -> Pathname | nil (9307.0) -
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し ます。
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し
ます。
指定されていない場合は nil を返します。 -
RDoc
:: Options # rdoc _ include -> [String] (9307.0) -
コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。
コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。
指定しなかった場合は ['.'] を返します。 -
RDoc
:: Options # webcvs -> String | nil (9307.0) -
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま
す。
指定しなかった場合は nil を返します。 -
RDoc
:: Stats # num _ classes -> Integer (9307.0) -
解析したクラスの数を返します。
解析したクラスの数を返します。 -
RDoc
:: Stats # num _ files -> Integer (9307.0) -
解析したファイルの数を返します。
解析したファイルの数を返します。 -
RDoc
:: Stats # num _ modules -> Integer (9307.0) -
解析したモジュールの数を返します。
解析したモジュールの数を返します。 -
RDoc
:: Text # markup(text) -> String (9307.0) -
引数を整形します。
引数を整形します。
include したクラスに self#formatter メソッドが必要です。
@param text 文字列を指定します。 -
RDoc
:: Text # parse(text) -> RDoc :: Markup :: Document | Array (9307.0) -
引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。
...引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。
@param text 文字列を指定します。
@see RDoc::Text#normalize_comment... -
RDoc
:: TopLevel # add _ class _ or _ module(collection , class _ type , name , superclass) -> 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
:: TopLevel # find _ local _ symbol(name) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule | RDoc :: AnyMethod | RDoc :: Alias | RDoc :: Attr | RDoc :: Constant (9307.0) -
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。 -
RDoc
:: TopLevel # full _ name -> String (9307.0) -
自身が管理するファイルの名前を返します。
自身が管理するファイルの名前を返します。 -
RDoc
:: CodeObject # remove _ classes _ and _ modules -> () (9007.0) -
何もしません。RDoc::CodeObject#document_children= に false を指定 した時のコールバックとして呼び出されます。オーバーライドして使用します。
...何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。... -
RDoc
:: Context # add _ alias(an _ alias) -> RDoc :: Alias (9007.0) -
引数で指定した RDoc::Alias オブジェクトを追加します。
...引数で指定した RDoc::Alias オブジェクトを追加します。
@param an_alias RDoc::Alias オブジェクトを指定します。... -
RDoc
:: Context # add _ include(an _ include) -> () (9007.0) -
引数で指定した RDoc::Include オブジェクトを追加します。
...引数で指定した RDoc::Include オブジェクトを追加します。
@param an_include RDoc::Include オブジェクトを指定します。... -
RDoc
:: Context # add _ require(a _ require) -> () (9007.0) -
自身が所属する RDoc::TopLevel オブジェクトに引数で指定した RDoc::Require を追加します。
...自身が所属する RDoc::TopLevel オブジェクトに引数で指定した
RDoc::Require を追加します。
@param a_require RDoc::Require オブジェクトを指定します。... -
RDoc
:: Context # aliases -> [RDoc :: Alias] (9007.0) -
追加された RDoc::Alias の配列を返します。
...追加された RDoc::Alias の配列を返します。... -
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 _ classmodule {|m| . . . } -> [RDoc :: SingleClass | RDoc :: NormalClass | RDoc :: NormalModule] (9007.0) -
追加されたクラス、モジュールに対してブロックを評価します。
...追加されたクラス、モジュールに対してブロックを評価します。
@see RDoc::Context#classes, RDoc::Context#modules... -
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 # 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 # modules -> [RDoc :: NormalModule] (9007.0) -
追加された RDoc::NormalModule の配列を返します。
...追加された RDoc::NormalModule の配列を返します。... -
RDoc
:: Context # requires -> [RDoc :: Require] (9007.0) -
追加された RDoc::Require の配列を返します。
...追加された RDoc::Require の配列を返します。... -
RDoc
:: Options # all _ one _ file -> bool (9007.0) -
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。 -
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 # fileboxes -> bool (9007.0) -
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定 していた場合、true を返します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定
していた場合、true を返します。そうでない場合は false を返します。 -
RDoc
:: Options # finish _ page _ dir (9007.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
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 # 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=(val) (9007.0) -
コマンドライン引数の --main オプションと同様の指定を行います。
コマンドライン引数の --main オプションと同様の指定を行います。
@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。 -
RDoc
:: Options # markup=(val) (9007.0) -
コマンドライン引数の --markup オプションと同様の指定を行います。
コマンドライン引数の --markup オプションと同様の指定を行います。
@param val フォーマットを文字列で指定します。 -
RDoc
:: Options # op _ dir=(val) (9007.0) -
コマンドライン引数の --op オプションと同様の指定を行います。
コマンドライン引数の --op オプションと同様の指定を行います。
@param val 設定するディレクトリを文字列で指定します。 -
RDoc
:: Options # page _ dir=(val) (9007.0) -
コマンドライン引数の --page-dir オプションと同様の指定を行います。
コマンドライン引数の --page-dir オプションと同様の指定を行います。
@param val パスを文字列で指定します。 -
RDoc
:: Options # parse(argv) -> () (9007.0) -
コマンドライン引数を解析します。
コマンドライン引数を解析します。
@param argv コマンドライン引数を文字列の配列で指定します。
また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。
* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合 -
RDoc
:: Options # pipe -> bool (9007.0) -
コマンドライン引数の --pipe オプションを指定していた場合、true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --pipe オプションを指定していた場合、true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # pipe=(val) (9007.0) -
val に true を指定した場合、コマンドライン引数の --pipe オプションと同 様の指定を行います。
val に true を指定した場合、コマンドライン引数の --pipe オプションと同
様の指定を行います。
@param val --pipe オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。 -
RDoc
:: Options # promiscuous (9007.0) -
コマンドライン引数の --promiscuous を指定していた場合に true を返します。 そうでない場合は false を返します。
コマンドライン引数の --promiscuous を指定していた場合に true を返します。
そうでない場合は false を返します。 -
RDoc
:: Options # show _ all -> bool (9007.0) -
コマンドライン引数の --all オプションを指定していた場合、true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --all オプションを指定していた場合、true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # show _ all=(val) (9007.0) -
val に true を指定した場合、コマンドライン引数の --all オプションと同様 の指定を行います。
val に true を指定した場合、コマンドライン引数の --all オプションと同様
の指定を行います。
@param val --all オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。 -
RDoc
:: Options # show _ hash -> bool (9007.0) -
コマンドライン引数の --show-hash オプションを指定していた場合、true を 返します。そうでない場合は false を返します。
コマンドライン引数の --show-hash オプションを指定していた場合、true を
返します。そうでない場合は false を返します。 -
RDoc
:: Options # warn(message) -> nil (9007.0) -
--verbose オプションを指定していた場合に message を 標準エラー出力 $stderr に出力します。
--verbose オプションを指定していた場合に message を 標準エラー出力
$stderr に出力します。 -
RDoc
:: Stats # num _ classes=(val) (9007.0) -
解析したクラスの数を指定します。
解析したクラスの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ files=(val) (9007.0) -
解析したファイルの数を指定します。
解析したファイルの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ modules=(val) (9007.0) -
解析したモジュールの数を指定します。
解析したモジュールの数を指定します。
@param val 数値を指定します。 -
RDoc
:: TopLevel # find _ module _ named(name) -> RDoc :: NormalModule (9007.0) -
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。 見つからなかった場合は nil を返します。
...
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。
見つからなかった場合は nil を返します。
@param name モジュール名を文字列で指定します。... -
RDoc
:: Markdown # parse(markdown) -> RDoc :: Markup :: Document (307.0) -
引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。
...引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。
@param markdown 解析の対象になるドキュメントを文字列で指定します。... -
RDoc
:: Markup # add _ special(pattern , name) -> () (307.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
:: Markup # add _ word _ pair(start , stop , name) -> () (307.0) -
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。
...ます。
@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。
例:
require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_word_pair("{", "}", :STRIKE)
h = SM::ToHtml.new
h.add_tag(:S... -
RDoc
:: Parser :: C # scan -> RDoc :: TopLevel (307.0) -
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析します。
...C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析します。
@return RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Parser :: ChangeLog # scan -> RDoc :: TopLevel (307.0) -
ChangeLog ファイルを解析します。
...ChangeLog ファイルを解析します。
@return RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Parser :: Markdown # scan -> RDoc :: TopLevel (307.0) -
Markdown 形式で記述されたファイルを解析します。
...Markdown 形式で記述されたファイルを解析します。
@return RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Parser :: RD # scan -> RDoc :: TopLevel (307.0) -
RD 形式で記述されたファイルを解析します。
...RD 形式で記述されたファイルを解析します。
@return RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Parser :: Ruby # scan -> RDoc :: TopLevel (307.0) -
Ruby のソースコードからクラス/モジュールのドキュメントを解析します。
...Ruby のソースコードからクラス/モジュールのドキュメントを解析します。
@return RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Parser :: Simple # scan -> RDoc :: TopLevel (307.0) -
自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し ます。
...自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し
ます。
@return RDoc::TopLevel オブジェクトを返します。...