種類
- インスタンスメソッド (203)
- クラス (40)
- 特異メソッド (27)
- 定数 (24)
- モジュール (8)
クラス
-
RDoc
:: CodeObject (19) -
RDoc
:: Context (45) -
RDoc
:: Context :: Section (8) -
RDoc
:: Generator :: Darkfish (4) -
RDoc
:: Generator :: JsonIndex (3) -
RDoc
:: Generator :: RI (3) -
RDoc
:: Markdown (21) -
RDoc
:: Markup (11) -
RDoc
:: Markup :: Formatter (3) -
RDoc
:: Markup :: ToAnsi (1) -
RDoc
:: Markup :: ToBs (1) -
RDoc
:: Markup :: ToHtml (1) -
RDoc
:: Markup :: ToHtmlCrossref (1) -
RDoc
:: Markup :: ToRdoc (1) -
RDoc
:: Options (72) -
RDoc
:: Parser (5) -
RDoc
:: Parser :: C (3) -
RDoc
:: Parser :: ChangeLog (1) -
RDoc
:: Parser :: Markdown (1) -
RDoc
:: Parser :: RD (1) -
RDoc
:: Parser :: Ruby (4) -
RDoc
:: Parser :: Simple (3) -
RDoc
:: RDoc (2) -
RDoc
:: Stats (10) -
RDoc
:: TopLevel (14)
モジュール
- RDoc (8)
-
RDoc
:: Text (8)
キーワード
- <=> (1)
- == (1)
-
ATTR
_ MODIFIERS (1) - Alias (1)
- AnonClass (1)
- AnyMethod (1)
- Attr (1)
- C (1)
-
CLASS
_ MODIFIERS (1) -
CONSTANT
_ MODIFIERS (1) - ChangeLog (1)
- ClassModule (1)
- CodeObject (1)
- Constant (1)
- Context (1)
-
DEFAULT
_ EXTENSIONS (1) - DEPRECATED (1)
- DESCRIPTION (1)
-
DOT
_ DOC _ FILENAME (1) - Darkfish (1)
- EXTENSIONS (1)
- Error (1)
- Formatter (1)
-
GENERAL
_ MODIFIERS (1) -
GENERATOR
_ DIR (1) - Generator (1)
- GhostMethod (1)
-
HTML
_ ENTITIES (1) - Include (1)
- JsonIndex (1)
-
KNOWN
_ CLASSES (1) -
LABEL
_ LIST _ RE (1) -
METHOD
_ MODIFIERS (1) - Markdown (2)
- Markup (2)
- MetaMethod (1)
- NORMAL (1)
- NormalClass (1)
- NormalModule (1)
- Options (1)
- Parser (1)
- RD (1)
- RDoc (2)
- RI (1)
- Require (1)
- Ruby (1)
- RubyLex (1)
- RubyToken (1)
- RubyTools (1)
-
SEARCH
_ INDEX _ FILE (1) -
SIMPLE
_ LIST _ RE (1) - SINGLE (1)
- SPACE (1)
- SPECIAL (1)
- Section (1)
- Simple (1)
- SingleClass (1)
- Stats (1)
- TYPES (1)
- Text (2)
- ToAnsi (1)
- ToBs (1)
- ToHtml (1)
- ToHtmlCrossref (1)
- ToRdoc (1)
- TokenStream (1)
- TopLevel (1)
- VERSION (2)
- VISIBILITIES (1)
-
add
_ alias (1) -
add
_ attribute (1) -
add
_ class (1) -
add
_ class _ or _ module (2) -
add
_ constant (1) -
add
_ generator (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) -
alias
_ extension (1) - aliases (1)
-
all
_ classes _ and _ modules (1) -
all
_ one _ file (1) -
attribute
_ manager (1) - attributes (1)
-
break
_ on _ newline (1) -
break
_ on _ newline= (1) -
can
_ parse (1) - charset (1)
- classes (1)
- comment (2)
- comment= (1)
- constants (1)
- content (1)
- convert (2)
-
coverage
_ report (1) -
coverage
_ report= (1) - css (2)
- 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 (2)
- 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
_ class _ named (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)
- new (17)
-
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 (4)
-
parse
_ files _ matching (1) -
parser
_ for (1) - parsers (1)
- pipe (1)
- pipe= (1)
- print (1)
- progress= (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)
- reset (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 # 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) -
解析するファイルの一覧を文字列の配列で返します。
解析するファイルの一覧を文字列の配列で返します。 -
RDoc
:: Options # finish _ page _ dir (9004.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: Options # force _ output -> bool (9004.0) -
コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返 します。
コマンドライン引数の --force_output オプションを指定していた場合、true
を返します。--no-force_output オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は true を返します。 -
RDoc
:: Options # force _ output=(val) (9004.0) -
val に true を指定した場合、コマンドライン引数の --force_output オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。
@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # force _ update -> bool (9004.0) -
コマンドライン引数の --force_update を指定していた場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --force_update を指定していた場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # formatter -> nil (9004.0) -
使用されていません。常に nil を返します。
使用されていません。常に nil を返します。 -
RDoc
:: Options # formatter=(val) (9004.0) -
使用されていません。
使用されていません。 -
RDoc
:: Options # generator -> Generator (9004.0) -
コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。
コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。
指定しなかった場合は、HTML に対応する Generator を返します。 -
RDoc
:: Options # generator=(val) (9004.0) -
コマンドライン引数の --fmt オプションと同様の指定を行います。
コマンドライン引数の --fmt オプションと同様の指定を行います。
@param val 設定する Generator を指定します。 -
RDoc
:: Options # hyperlink _ all -> bool (9004.0) -
コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。
コマンドライン引数の --hyperlink-all オプションを指定していた場合、
true を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # hyperlink _ all=(val) (9004.0) -
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ
ンと同様の指定を行います。
@param val --hyperlink-all オプションと同じ指定を行う場合は true、そう
でない場合は false を指定します。 -
RDoc
:: Options # image _ format -> String (9004.0) -
コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。
コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。
指定しなかった場合は 'png' を返します。 -
RDoc
:: Options # include _ line _ numbers -> bool (9004.0) -
コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。
コマンドライン引数の --include-line-numbers を指定していた場合に true
を返します。そうでない場合は false を返します。 -
RDoc
:: Options # inline _ source -> bool (9004.0) -
コマンドライン引数の --inline-source オプションか --one-file を指定して いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --inline-source オプションか --one-file を指定して
いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # line _ numbers -> bool (9004.0) -
コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返 します。
コマンドライン引数の --line-numbers オプションを指定していた場合、true
を返します。--no-line-numbers オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # line _ numbers=(val) (9004.0) -
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ
ンと同様の指定を行います。
@param val --line-numbers オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # main _ page -> String | nil (9004.0) -
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # main _ page=(val) (9004.0) -
コマンドライン引数の --main オプションと同様の指定を行います。
コマンドライン引数の --main オプションと同様の指定を行います。
@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。 -
RDoc
:: Options # markup=(val) (9004.0) -
コマンドライン引数の --markup オプションと同様の指定を行います。
コマンドライン引数の --markup オプションと同様の指定を行います。
@param val フォーマットを文字列で指定します。 -
RDoc
:: Options # merge -> true | nil (9004.0) -
コマンドライン引数の --merge オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
コマンドライン引数の --merge オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。 -
RDoc
:: Options # op _ dir -> String (9004.0) -
コマンドライン引数の --op オプションで指定したディレクトリを返します。
コマンドライン引数の --op オプションで指定したディレクトリを返します。
--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。
@return 設定されたディレクトリを文字列で返します。 -
RDoc
:: Options # op _ dir=(val) (9004.0) -
コマンドライン引数の --op オプションと同様の指定を行います。
コマンドライン引数の --op オプションと同様の指定を行います。
@param val 設定するディレクトリを文字列で指定します。 -
RDoc
:: Options # op _ name -> String (9004.0) -
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま す。
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま
す。 -
RDoc
:: Options # option _ parser -> OptionParser | nil (9004.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。
コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。 -
RDoc
:: Options # option _ parser=(val) (9004.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。
コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。
@param val OptionParser オブジェクトを指定します。 -
RDoc
:: Options # page _ dir -> Pathname | nil (9004.0) -
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し ます。
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し
ます。
指定されていない場合は nil を返します。 -
RDoc
:: Options # page _ dir=(val) (9004.0) -
コマンドライン引数の --page-dir オプションと同様の指定を行います。
コマンドライン引数の --page-dir オプションと同様の指定を行います。
@param val パスを文字列で指定します。 -
RDoc
:: Options # parse(argv) -> () (9004.0) -
コマンドライン引数を解析します。
コマンドライン引数を解析します。
@param argv コマンドライン引数を文字列の配列で指定します。
また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。
* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合 -
RDoc
:: Options # pipe -> bool (9004.0) -
コマンドライン引数の --pipe オプションを指定していた場合、true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --pipe オプションを指定していた場合、true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # pipe=(val) (9004.0) -
val に true を指定した場合、コマンドライン引数の --pipe オプションと同 様の指定を行います。
val に true を指定した場合、コマンドライン引数の --pipe オプションと同
様の指定を行います。
@param val --pipe オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。 -
RDoc
:: Options # promiscuous (9004.0) -
コマンドライン引数の --promiscuous を指定していた場合に true を返します。 そうでない場合は false を返します。
コマンドライン引数の --promiscuous を指定していた場合に true を返します。
そうでない場合は false を返します。 -
RDoc
:: Options # quiet -> bool (9004.0) -
コマンドライン引数の --quiet オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
コマンドライン引数の --quiet オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。 -
RDoc
:: Options # root -> Pathname (9004.0) -
コマンドライン引数の --root オプションで指定したディレクトリを返します。
コマンドライン引数の --root オプションで指定したディレクトリを返します。
指定されていない場合はカレントディレクトリを返します。 -
RDoc
:: Options # root=(val) (9004.0) -
コマンドライン引数の --root オプションと同様の指定を行います。
コマンドライン引数の --root オプションと同様の指定を行います。
@param val パスを文字列で指定します。 -
RDoc
:: Options # sanitize _ path(path) (9004.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: Options # show _ all -> bool (9004.0) -
コマンドライン引数の --all オプションを指定していた場合、true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --all オプションを指定していた場合、true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # show _ all=(val) (9004.0) -
val に true を指定した場合、コマンドライン引数の --all オプションと同様 の指定を行います。
val に true を指定した場合、コマンドライン引数の --all オプションと同様
の指定を行います。
@param val --all オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。 -
RDoc
:: Options # show _ hash -> bool (9004.0) -
コマンドライン引数の --show-hash オプションを指定していた場合、true を 返します。そうでない場合は false を返します。
コマンドライン引数の --show-hash オプションを指定していた場合、true を
返します。そうでない場合は false を返します。 -
RDoc
:: Options # static _ path -> [String] (9004.0) -
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し ます。
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。 -
RDoc
:: Options # static _ path=(vals) (9004.0) -
コマンドライン引数の --copy-files オプションと同様の指定を行います。
コマンドライン引数の --copy-files オプションと同様の指定を行います。
@param vals パスを文字列の配列で指定します。 -
RDoc
:: Options # tab _ width -> Integer (9004.0) -
コマンドライン引数の --tab-width オプションで指定した数値を返します。
コマンドライン引数の --tab-width オプションで指定した数値を返します。 -
RDoc
:: Options # template -> String (9004.0) -
コマンドライン引数の --template オプションで指定した名前を文字列の配列 で返します。
コマンドライン引数の --template オプションで指定した名前を文字列の配列
で返します。
指定しなかった場合は 'html' を返します。 -
RDoc
:: Options # template _ dir -> String | nil (9004.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを返します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。
オプションの解析前は nil を返します。 -
RDoc
:: Options # template _ dir=(val) (9004.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを設定します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。
@param val パスを文字列で指定します。 -
RDoc
:: Options # title -> String | nil (9004.0) -
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。 -
RDoc
:: Options # title=(string) (9004.0) -
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文 字列に設定します。
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文
字列に設定します。
コマンドライン引数で既に --title オプションが指定されていた場合には、そ
ちらを優先します。
@param string 設定するタイトルを文字列で指定します。 -
RDoc
:: Options # verbosity -> 0 | 1 | 2 (9004.0) -
プログラムの解析時に表示する情報の詳細さを数値で返します。
プログラムの解析時に表示する情報の詳細さを数値で返します。
以下の値を指定する事ができます。
: 0(--quiet オプションを指定した場合)
情報を表示しません。
: 1
通常の表示を行います。
: 2(--verbose オプションを指定した場合)
詳細な情報を表示します。 -
RDoc
:: Options # visibility -> :public | :protected | :private (9004.0) -
コマンドライン引数の --visibility で指定したオプションを Symbol で返します。
コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。 -
RDoc
:: Options # visibility=(val) (9004.0) -
コマンドライン引数の --visibility オプションと同様の指定を行います。
コマンドライン引数の --visibility オプションと同様の指定を行います。
@param val :public、:protected、:private のいずれかを指定します。 -
RDoc
:: Options # warn(message) -> nil (9004.0) -
--verbose オプションを指定していた場合に message を 標準エラー出力 $stderr に出力します。
--verbose オプションを指定していた場合に message を 標準エラー出力
$stderr に出力します。 -
RDoc
:: Options # webcvs -> String | nil (9004.0) -
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま
す。
指定しなかった場合は nil を返します。 -
RDoc
:: Options :: DEPRECATED -> {String -> String} (9004.0) -
非推奨のオプションの一覧を返します。
非推奨のオプションの一覧を返します。 -
RDoc
:: Parser (9004.0) -
ソースコードを解析するパーサを生成するための基本クラスです。
ソースコードを解析するパーサを生成するための基本クラスです。
新しいパーサを作成する場合には継承して使用します。 -
RDoc
:: Parser . alias _ extension(old _ ext , new _ ext) -> bool (9004.0) -
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登 録します。
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登
録します。
@param old_ext 拡張子を文字列で指定します。
@param new_ext 拡張子を文字列で指定します。
@return エイリアスが登録された場合は true を返します。old_ext にパーサ
が登録されていない場合、エイリアスが登録されずに false を返しま
す。 -
RDoc
:: Parser :: C (9004.0) -
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析するためのクラスです。
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析するためのクラスです。 -
RDoc
:: Parser :: C # progress=(val) (9004.0) -
進捗を出力する IO を指定します。
進捗を出力する IO を指定します。
@param val 進捗を出力する IO を指定します。指定しなかった場合は
$stderr が使われます。 -
RDoc
:: Parser :: ChangeLog (9004.0) -
ChangeLog ファイルを解析するためのクラスです。
ChangeLog ファイルを解析するためのクラスです。 -
RDoc
:: Parser :: Markdown (9004.0) -
Markdown 形式で記述されたファイルを解析するためのクラスです。
Markdown 形式で記述されたファイルを解析するためのクラスです。
解析された情報はコメントとして扱われます。 -
RDoc
:: Parser :: RD (9004.0) -
RD 形式で記述されたファイルを解析するためのクラスです。
RD 形式で記述されたファイルを解析するためのクラスです。
解析された情報はコメントとして扱われます。 -
RDoc
:: Parser :: Ruby (9004.0) -
Ruby のソースコードを解析するためのクラスです。
Ruby のソースコードを解析するためのクラスです。 -
RDoc
:: Parser :: Simple (9004.0) -
ソースコード以外のファイルを解析するためのクラスです。
ソースコード以外のファイルを解析するためのクラスです。 -
RDoc
:: Parser :: Simple # remove _ private _ comments(comment) -> String (9004.0) -
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返 します。
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。
@param comment 対象の文字列を指定します。
@return コメントが削除された文字列を返します。 -
RDoc
:: Require (9004.0) -
require されるファイルを表現します。
require されるファイルを表現します。
ライブラリの内部で使用します。 -
RDoc
:: RubyLex (9004.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: RubyToken (9004.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: SingleClass (9004.0) -
特異クラスを表現するクラスです。
特異クラスを表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: Stats # num _ classes -> Integer (9004.0) -
解析したクラスの数を返します。
解析したクラスの数を返します。 -
RDoc
:: Stats # num _ classes=(val) (9004.0) -
解析したクラスの数を指定します。
解析したクラスの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ files -> Integer (9004.0) -
解析したファイルの数を返します。
解析したファイルの数を返します。 -
RDoc
:: Stats # num _ files=(val) (9004.0) -
解析したファイルの数を指定します。
解析したファイルの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ methods -> Integer (9004.0) -
解析したメソッドの数を返します。
解析したメソッドの数を返します。 -
RDoc
:: Stats # num _ methods=(val) (9004.0) -
解析したメソッドの数を指定します。
解析したメソッドの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ modules -> Integer (9004.0) -
解析したモジュールの数を返します。
解析したモジュールの数を返します。 -
RDoc
:: Stats # num _ modules=(val) (9004.0) -
解析したモジュールの数を指定します。
解析したモジュールの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # print -> () (9004.0) -
自身の持つ情報を標準出力に表示します。
自身の持つ情報を標準出力に表示します。 -
RDoc
:: Text (9004.0) -
コメントテキストを処理するためのクラスです。
コメントテキストを処理するためのクラスです。 -
RDoc
:: Text # expand _ tabs(text) -> String (9004.0) -
引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな るように置き換えます。
引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな
るように置き換えます。
@param text 文字列を指定します。 -
RDoc
:: Text # flush _ left(text) -> String (9004.0) -
引数から各行の行頭のスペースを削除します。
引数から各行の行頭のスペースを削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # markup(text) -> String (9004.0) -
引数を整形します。
引数を整形します。
include したクラスに self#formatter メソッドが必要です。
@param text 文字列を指定します。 -
RDoc
:: Text # strip _ hashes(text) -> String (9004.0) -
引数から各行の行頭の # を削除します。
引数から各行の行頭の # を削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # strip _ newlines(text) -> String (9004.0) -
引数から先頭と末尾の改行を削除します。
引数から先頭と末尾の改行を削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # strip _ stars(text) -> String (9004.0) -
引数から /* 〜 */ 形式のコメントを削除します。
引数から /* 〜 */ 形式のコメントを削除します。
@param text 文字列を指定します。 -
RDoc
:: TokenStream (9004.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: TopLevel (9004.0) -
最上位のコンテキスト(ソースファイル)を表現するクラスです。
最上位のコンテキスト(ソースファイル)を表現するクラスです。 -
RDoc
:: TopLevel # file _ absolute _ name -> String (9004.0) -
自身が管理するファイルに関する絶対パスを文字列で返します。
自身が管理するファイルに関する絶対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ absolute _ name=(val) (9004.0) -
自身が管理するファイルに関する絶対パスを文字列で設定します。
自身が管理するファイルに関する絶対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ relative _ name -> String (9004.0) -
自身が管理するファイルに関する相対パスを文字列で返します。
自身が管理するファイルに関する相対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ relative _ name=(val) (9004.0) -
自身が管理するファイルに関する相対パスを文字列で設定します。
自身が管理するファイルに関する相対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ stat -> File :: Stat (9004.0) -
自身が管理するファイルに関する File::Stat オブジェクトを返します。
自身が管理するファイルに関する File::Stat オブジェクトを返します。