種類
- インスタンスメソッド (140)
- 特異メソッド (21)
- 定数 (15)
- クラス (13)
- モジュール (1)
クラス
-
RDoc
:: CodeObject (9) -
RDoc
:: Context (29) -
RDoc
:: Context :: Section (4) -
RDoc
:: Generator :: Darkfish (1) -
RDoc
:: Generator :: JsonIndex (1) -
RDoc
:: Generator :: RI (1) -
RDoc
:: Markdown (18) -
RDoc
:: Markup (6) -
RDoc
:: Markup :: Formatter (1) -
RDoc
:: Markup :: ToAnsi (1) -
RDoc
:: Markup :: ToBs (1) -
RDoc
:: Markup :: ToHtml (1) -
RDoc
:: Markup :: ToHtmlCrossref (1) -
RDoc
:: Markup :: ToRdoc (1) -
RDoc
:: Options (54) -
RDoc
:: Parser (4) -
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 (7) -
RDoc
:: TopLevel (14)
モジュール
- RDoc (4)
-
RDoc
:: Text (3)
キーワード
- == (1)
- Alias (1)
- AnonClass (1)
-
CLASS
_ MODIFIERS (1) - ChangeLog (1)
- ClassModule (1)
-
DEFAULT
_ EXTENSIONS (1) -
DOT
_ DOC _ FILENAME (1) - EXTENSIONS (1)
-
GENERAL
_ MODIFIERS (1) -
HTML
_ ENTITIES (1) - Include (1)
-
KNOWN
_ CLASSES (1) -
LABEL
_ LIST _ RE (1) - NORMAL (1)
- NormalClass (1)
- NormalModule (1)
- RubyLex (1)
- RubyTools (1)
-
SEARCH
_ INDEX _ FILE (1) -
SIMPLE
_ LIST _ RE (1) - SINGLE (1)
- SPECIAL (1)
- Simple (1)
- SingleClass (1)
- TYPES (1)
- ToHtml (1)
- ToHtmlCrossref (1)
- TopLevel (1)
- VISIBILITIES (1)
-
add
_ alias (1) -
add
_ class (1) -
add
_ class _ or _ module (2) -
add
_ generator (1) -
add
_ html (1) -
add
_ include (1) -
add
_ module (1) -
add
_ special (1) -
alias
_ extension (1) - aliases (1)
-
all
_ classes _ and _ modules (1) -
all
_ one _ file (1) -
break
_ on _ newline (1) -
break
_ on _ newline= (1) -
can
_ parse (1) - classes (1)
- comment (1)
-
coverage
_ report (1) -
coverage
_ report= (1) - css (1)
- css= (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
_ classmodule (1) - encoding= (1)
- exclude (1)
- exclude= (1)
- extension (2)
-
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) -
flush
_ left (1) -
force
_ output (1) -
force
_ output= (1) -
force
_ update (1) - formatter (1)
- formatter= (1)
-
full
_ name (1) - generator= (1)
-
get
_ line _ types (1) - github (1)
- github= (1)
- html (1)
- html= (1)
-
hyperlink
_ all (1) -
hyperlink
_ all= (1) -
in
_ files (1) -
include
_ line _ numbers (1) - includes (1)
- initialize (2)
-
initialize
_ classes _ and _ modules (1) -
initialize
_ methods _ etc (1) -
inline
_ source (1) -
line
_ numbers (1) -
line
_ numbers= (1) -
main
_ page (1) -
main
_ page= (1) - markup= (1)
- merge (1)
-
method
_ list (1) - modules (1)
- new (13)
-
normalize
_ comment (1) - notes (1)
- notes= (1)
-
num
_ classes (1) -
num
_ classes= (1) -
num
_ files (1) -
num
_ files= (1) -
num
_ methods= (1) -
num
_ modules (1) -
num
_ modules= (1) -
ongoing
_ visibility= (1) -
op
_ dir= (1) -
option
_ parser (1) -
option
_ parser= (1) -
page
_ dir (1) -
page
_ dir= (1) - parent= (1)
-
parent
_ file _ name (1) -
parse
_ files _ matching (1) -
parser
_ for (1) - pipe (1)
- pipe= (1)
- progress= (1)
- quiet (1)
-
rdoc
_ include (1) -
record
_ location (1) -
remove
_ classes _ and _ modules (1) -
remove
_ private _ comments (1) - reset (1)
- root= (1)
- scan (6)
- section= (1)
-
set
_ current _ section (1) -
set
_ visibility _ for (1) -
show
_ all (1) -
show
_ all= (1) -
show
_ hash (1) -
static
_ path= (1) -
strip
_ newlines (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)
- visibility (2)
- visibility= (1)
- warn (1)
- webcvs (1)
検索結果
先頭5件
- RDoc
:: Context # unmatched _ alias _ lists -> {String => RDoc :: Alias} - RDoc
:: Context # unmatched _ alias _ lists=(val) - RDoc
:: TopLevel # add _ class _ or _ module(collection , class _ type , name , superclass) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule - RDoc
:: TopLevel # file _ stat -> File :: Stat - RDoc
:: TopLevel # find _ module _ named(name) -> RDoc :: NormalModule
-
RDoc
:: Context # unmatched _ alias _ lists -> {String => RDoc :: Alias} (36904.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。
...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。... -
RDoc
:: Context # unmatched _ alias _ lists=(val) (36604.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を設定します。
...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を設定します。
@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。... -
RDoc
:: TopLevel # add _ class _ or _ module(collection , class _ type , name , superclass) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule (28504.0) -
collection に name で指定したクラス、モジュールを追加します。
...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass......オ
ブジェクトで指定します。
既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。... -
RDoc
:: TopLevel # file _ stat -> File :: Stat (27604.0) -
自身が管理するファイルに関する File::Stat オブジェクトを返します。
自身が管理するファイルに関する File::Stat オブジェクトを返します。 -
RDoc
:: TopLevel # find _ module _ named(name) -> RDoc :: NormalModule (27604.0) -
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。 見つからなかった場合は nil を返します。
...
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。
見つからなかった場合は nil を返します。
@param name モジュール名を文字列で指定します。... -
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 オブジェクトを指定します。 -
RDoc
:: TopLevel . all _ classes _ and _ modules -> [RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule] (27304.0) -
RDoc が収集したクラス、モジュールを配列で返します。
...
RDoc が収集したクラス、モジュールを配列で返します。... -
RDoc
:: Context # add _ class(class _ type , name , superclass) -> RDoc :: SingleClass | RDoc :: NormalClass (19504.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 (19504.0) -
collection に name で指定したクラス、モジュールを追加します。
...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass......オ
ブジェクトで指定します。
既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。... -
RDoc
:: Context # add _ alias(an _ alias) -> RDoc :: Alias (18904.0) -
引数で指定した RDoc::Alias オブジェクトを追加します。
...引数で指定した RDoc::Alias オブジェクトを追加します。
@param an_alias RDoc::Alias オブジェクトを指定します。... -
RDoc
:: Context # add _ module(class _ type , name) -> RDoc :: NormalModule | RDoc :: SingleClass | RDoc :: NormalClass (18904.0) -
引数で指定したモジュールを追加します。
...ram class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@see RDoc::Context#add_class... -
RDoc
:: Context # classes -> [RDoc :: SingleClass | RDoc :: NormalClass] (18904.0) -
追加されたクラスの配列を返します。
追加されたクラスの配列を返します。 -
RDoc
:: Context # each _ classmodule {|m| . . . } -> [RDoc :: SingleClass | RDoc :: NormalClass | RDoc :: NormalModule] (18904.0) -
追加されたクラス、モジュールに対してブロックを評価します。
...追加されたクラス、モジュールに対してブロックを評価します。
@see RDoc::Context#classes, RDoc::Context#modules... -
RDoc
:: TopLevel . find _ class _ named(name) -> RDoc :: NormalClass | RDoc :: SingleClass | nil (18904.0) -
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ からなかった場合は nil を返します。
...
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ
からなかった場合は nil を返します。
@param name クラス名を文字列で指定します。... -
RDoc
:: Context # add _ include(an _ include) -> () (18604.0) -
引数で指定した RDoc::Include オブジェクトを追加します。
...引数で指定した RDoc::Include オブジェクトを追加します。
@param an_include RDoc::Include オブジェクトを指定します。... -
RDoc
:: Context # aliases -> [RDoc :: Alias] (18604.0) -
追加された RDoc::Alias の配列を返します。
...追加された RDoc::Alias の配列を返します。... -
RDoc
:: Context # find _ module _ named(name) -> RDoc :: NormalModule | nil (18604.0) -
追加された RDoc::NormalModule から引数で指定した名前のモジュール を検索します。見つからなかった場合は nil を返します。
...追加された RDoc::NormalModule から引数で指定した名前のモジュール
を検索します。見つからなかった場合は nil を返します。
@param name モジュールの名前を文字列で指定します。... -
RDoc
:: Context # includes -> [RDoc :: Include] (18604.0) -
追加された RDoc::Include の配列を返します。
...追加された RDoc::Include の配列を返します。... -
RDoc
:: Context # modules -> [RDoc :: NormalModule] (18604.0) -
追加された RDoc::NormalModule の配列を返します。
...追加された RDoc::NormalModule の配列を返します。... -
RDoc
:: Context # set _ visibility _ for(methods , visibility , singleton = false) -> () (18604.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 # toplevel -> RDoc :: TopLevel (18604.0) -
自身が所属する RDoc::TopLevel オブジェクトを返します。
...自身が所属する RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Context # visibility -> :public | :protected | :private (18604.0) -
自身の可視性を Symbol で返します。
自身の可視性を Symbol で返します。 -
RDoc
:: Context :: VISIBILITIES -> [:public , :protected , :private] (18604.0) -
メソッドの可視性を Symbol の配列で返します。
メソッドの可視性を Symbol の配列で返します。 -
RDoc
:: Markdown # html -> bool (18604.0) -
HTML を記述した場合にそのまま出力するかどうかを返します。
HTML を記述した場合にそのまま出力するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Options # visibility -> :public | :protected | :private (18604.0) -
コマンドライン引数の --visibility で指定したオプションを Symbol で返します。
コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。 -
RDoc
:: CLASS _ MODIFIERS -> [String] (18307.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: DOT _ DOC _ FILENAME -> " . document" (18307.0) -
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。
...
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。... -
RDoc
:: GENERAL _ MODIFIERS -> [String] (18307.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: CodeObject # document _ children -> bool (18304.0) -
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを返します。
...自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを返します。
@see RDoc::CodeObject#document_self... -
RDoc
:: CodeObject # document _ children=(val) (18304.0) -
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを設定します。
...トに含めるか
どうかを設定します。
:nodoc:、:stopdoc: を指定した時に false が設定されます。
@param val true を指定した場合、上記をドキュメントに含めます。
@see RDoc::CodeObject#document_self=,
RDoc::CodeObject#remove_classes_and_modules... -
RDoc
:: CodeObject # document _ self -> bool (18304.0) -
自身をドキュメントに含めるかどうかを返します。
...自身をドキュメントに含めるかどうかを返します。
@see RDoc::CodeObject#document_children... -
RDoc
:: CodeObject # document _ self=(val) (18304.0) -
自身をドキュメントに含めるかどうかを設定します。
...c: を指定した時に true が設定されます。
:nodoc:、:stopdoc: を指定した時に false が設定されます。
@param val true を指定した場合、自身をドキュメントに含めます。
@see RDoc::CodeObject#document_children=,
RDoc::CodeObject#remove_methods_etc... -
RDoc
:: CodeObject # parent _ file _ name -> String (18304.0) -
self.parent のファイル名を返します。
...self.parent のファイル名を返します。
@see RDoc::CodeObject#parent... -
RDoc
:: CodeObject # remove _ classes _ and _ modules -> () (18304.0) -
何もしません。RDoc::CodeObject#document_children= に false を指定 した時のコールバックとして呼び出されます。オーバーライドして使用します。
...何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。... -
RDoc
:: Context # find _ enclosing _ module _ named(name) -> RDoc :: NormalModule | nil (18304.0) -
find a module at a higher scope
find a module at a higher scope -
RDoc
:: Context # find _ local _ symbol(symbol) (18304.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 _ 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 # in _ files (18304.0) -
Files this context is found in
Files this context is found in -
RDoc
:: Context # initialize _ classes _ and _ modules -> () (18304.0) -
追加されたクラスやモジュールをクリアします。
追加されたクラスやモジュールをクリアします。 -
RDoc
:: Context # initialize _ methods _ etc -> () (18304.0) -
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて いないものを含む)、require されたファイル、include されたファイル、定数 をクリアします。
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて
いないものを含む)、require されたファイル、include されたファイル、定数
をクリアします。 -
RDoc
:: Context # method _ list -> [RDoc :: AnyMethod] (18304.0) -
追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列 を返します。
...追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列
を返します。... -
RDoc
:: Context # ongoing _ visibility=(vis) (18304.0) -
Change the default visibility for new methods
Change the default visibility for new methods -
RDoc
:: Context # record _ location(toplevel) (18304.0) -
Record the file that we happen to find it in
Record the file that we happen to find it in -
RDoc
:: Context :: Section # title -> String | nil (18304.0) -
section のタイトルを返します。
section のタイトルを返します。 -
RDoc
:: Generator :: Darkfish # initialize(store , options) -> RDoc :: Generator :: Darkfish (18304.0) -
RDoc::Generator::Darkfish オブジェクトを初期化します。
...
RDoc::Generator::Darkfish オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。... -
RDoc
:: Generator :: JsonIndex :: SEARCH _ INDEX _ FILE -> String (18304.0) -
検索インデックスのパスを表す文字列です。
検索インデックスのパスを表す文字列です。 -
RDoc
:: Generator :: RI # initialize(store , options) -> RDoc :: Generator :: RI (18304.0) -
RDoc::Generator::RI オブジェクトを初期化します。
...
RDoc::Generator::RI オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。... -
RDoc
:: KNOWN _ CLASSES -> {String => String} (18304.0) -
Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
...Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"
ライブラリの内部で使用します。... -
RDoc
:: Markdown # break _ on _ newline -> bool (18304.0) -
改行を保持した状態で出力するかどうかを返します。
改行を保持した状態で出力するかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # break _ on _ newline=(val) (18304.0) -
改行を保持した状態で出力するかどうかを設定します。
改行を保持した状態で出力するかどうかを設定します。 -
RDoc
:: Markdown # definition _ lists -> bool (18304.0) -
定義リストを解釈するかどうかを返します。
定義リストを解釈するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # definition _ lists=(val) (18304.0) -
定義リストを解釈するかどうかを設定します。
定義リストを解釈するかどうかを設定します。 -
RDoc
:: Markdown # html=(val) (18304.0) -
HTML を記述した場合にそのまま出力するかどうかを設定します。
HTML を記述した場合にそのまま出力するかどうかを設定します。 -
RDoc
:: Markdown :: DEFAULT _ EXTENSIONS -> [Symbol] (18304.0) -
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。 -
RDoc
:: Markdown :: HTML _ ENTITIES -> {String => [Integer]} (18304.0) -
HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。
...HTML の実体参照のマッピングを表す Hash オブジェクトです。
RDoc::Markdown で使用します。... -
RDoc
:: Markup # add _ html(tag , name) -> () (18304.0) -
tag で指定したタグをフォーマットの対象にします。
...::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
例:
require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_html("no", :STRIKE)
h = SM::ToHtml.new
h.add_tag(:STRIKE,... -
RDoc
:: Markup # add _ special(pattern , name) -> () (18304.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 # get _ line _ types -> [Symbol] (18304.0) -
変換する文字列の各行のタイプを Symbol の配列で返します。
...変換する文字列の各行のタイプを Symbol の配列で返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
@see SM::SimpleMarkup#convert... -
RDoc
:: Markup :: LABEL _ LIST _ RE -> Regexp (18304.0) -
ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。
ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。 -
RDoc
:: Markup :: SIMPLE _ LIST _ RE -> Regexp (18304.0) -
リストにマッチする正規表現です。ライブラリの内部で使用します。
リストにマッチする正規表現です。ライブラリの内部で使用します。
ラベルの有無を問わずマッチします。 -
RDoc
:: Options # all _ one _ file -> bool (18304.0) -
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。 -
RDoc
:: Options # exclude -> Regexp (18304.0) -
コマンドライン引数の --exclude オプションで指定した正規表現を返します。 複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた ものを返します。
コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。 -
RDoc
:: Options # exclude=(val) (18304.0) -
コマンドライン引数の --exclude オプションと同様の指定を行います。
コマンドライン引数の --exclude オプションと同様の指定を行います。
@param val 設定するパターンを Regexp オブジェクトで指定します。 -
RDoc
:: Options # extra _ accessor _ flags -> {String => String} (18304.0) -
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。
値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。 -
RDoc
:: Options # fileboxes -> bool (18304.0) -
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定 していた場合、true を返します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定
していた場合、true を返します。そうでない場合は false を返します。 -
RDoc
:: Options # files -> [String] (18304.0) -
解析するファイルの一覧を文字列の配列で返します。
解析するファイルの一覧を文字列の配列で返します。 -
RDoc
:: Options # hyperlink _ all -> bool (18304.0) -
コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。
コマンドライン引数の --hyperlink-all オプションを指定していた場合、
true を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # hyperlink _ all=(val) (18304.0) -
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ
ンと同様の指定を行います。
@param val --hyperlink-all オプションと同じ指定を行う場合は true、そう
でない場合は false を指定します。 -
RDoc
:: Options # include _ line _ numbers -> bool (18304.0) -
コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。
コマンドライン引数の --include-line-numbers を指定していた場合に true
を返します。そうでない場合は false を返します。 -
RDoc
:: Options # inline _ source -> bool (18304.0) -
コマンドライン引数の --inline-source オプションか --one-file を指定して いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --inline-source オプションか --one-file を指定して
いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # line _ numbers -> bool (18304.0) -
コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返 します。
コマンドライン引数の --line-numbers オプションを指定していた場合、true
を返します。--no-line-numbers オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # line _ numbers=(val) (18304.0) -
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ
ンと同様の指定を行います。
@param val --line-numbers オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # rdoc _ include -> [String] (18304.0) -
コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。
コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。
指定しなかった場合は ['.'] を返します。 -
RDoc
:: Options # show _ all -> bool (18304.0) -
コマンドライン引数の --all オプションを指定していた場合、true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --all オプションを指定していた場合、true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # show _ all=(val) (18304.0) -
val に true を指定した場合、コマンドライン引数の --all オプションと同様 の指定を行います。
val に true を指定した場合、コマンドライン引数の --all オプションと同様
の指定を行います。
@param val --all オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。 -
RDoc
:: Options # template -> String (18304.0) -
コマンドライン引数の --template オプションで指定した名前を文字列の配列 で返します。
コマンドライン引数の --template オプションで指定した名前を文字列の配列
で返します。
指定しなかった場合は 'html' を返します。 -
RDoc
:: Options # template _ dir -> String | nil (18304.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを返します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。
オプションの解析前は nil を返します。 -
RDoc
:: Options # template _ dir=(val) (18304.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを設定します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。
@param val パスを文字列で指定します。 -
RDoc
:: Options # title -> String | nil (18304.0) -
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。 -
RDoc
:: Options # title=(string) (18304.0) -
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文 字列に設定します。
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文
字列に設定します。
コマンドライン引数で既に --title オプションが指定されていた場合には、そ
ちらを優先します。
@param string 設定するタイトルを文字列で指定します。 -
RDoc
:: Options # visibility=(val) (18304.0) -
コマンドライン引数の --visibility オプションと同様の指定を行います。
コマンドライン引数の --visibility オプションと同様の指定を行います。
@param val :public、:protected、:private のいずれかを指定します。 -
RDoc
:: Options :: SPECIAL -> [String] (18304.0) -
--write-options を指定した際に .rdoc_options ファイルに保存されないオプ ションの一覧を返します。
...--write-options を指定した際に .rdoc_options ファイルに保存されないオプ
ションの一覧を返します。... -
RDoc
:: Parser # parse _ files _ matching(regexp) -> () (18304.0) -
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。
...マッチするファイルを解析できるパーサとして、
自身を登録します。
@param regexp 正規表現を指定します。
新しいパーサを作成する時に使用します。
例:
class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end... -
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
:: Parser :: Ruby :: NORMAL -> " :: " (18304.0) -
RDoc::NormalClass type
...
RDoc::NormalClass type... -
RDoc
:: Parser :: Ruby :: SINGLE -> "<<" (18304.0) -
RDoc::SingleClass type
...
RDoc::SingleClass type... -
RDoc
:: Stats # num _ classes -> Integer (18304.0) -
解析したクラスの数を返します。
解析したクラスの数を返します。 -
RDoc
:: Stats # num _ classes=(val) (18304.0) -
解析したクラスの数を指定します。
解析したクラスの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ files -> Integer (18304.0) -
解析したファイルの数を返します。
解析したファイルの数を返します。 -
RDoc
:: Stats # num _ files=(val) (18304.0) -
解析したファイルの数を指定します。
解析したファイルの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ modules -> Integer (18304.0) -
解析したモジュールの数を返します。
解析したモジュールの数を返します。 -
RDoc
:: Stats # num _ modules=(val) (18304.0) -
解析したモジュールの数を指定します。
解析したモジュールの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Text # flush _ left(text) -> String (18304.0) -
引数から各行の行頭のスペースを削除します。
引数から各行の行頭のスペースを削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # normalize _ comment(text) -> String (18304.0) -
引数から行頭のスペースや改行文字などを削除します。
...から行頭のスペースや改行文字などを削除します。
詳しくは [SEE ALSO] の各メソッドを参照してください。
@param text 文字列を指定します。
@see RDoc::Text#strip_hashes, RDoc::Text#expand_tabs,
RDoc::Text#flush_left, RDoc::Text#strip_newlines... -
RDoc
:: Text # strip _ newlines(text) -> String (18304.0) -
引数から先頭と末尾の改行を削除します。
引数から先頭と末尾の改行を削除します。
@param text 文字列を指定します。 -
RDoc
:: TopLevel # find _ local _ symbol(name) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule | RDoc :: AnyMethod | RDoc :: Alias | RDoc :: Attr | RDoc :: Constant (18304.0) -
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。