種類
- インスタンスメソッド (158)
- 特異メソッド (26)
- 定数 (24)
- クラス (2)
クラス
-
RDoc
:: CodeObject (14) -
RDoc
:: Context (39) -
RDoc
:: Context :: Section (8) -
RDoc
:: Generator :: Darkfish (4) -
RDoc
:: Generator :: JsonIndex (3) -
RDoc
:: Generator :: RI (3) -
RDoc
:: Markdown (13) -
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 (53) -
RDoc
:: Parser (5) -
RDoc
:: Parser :: C (2) -
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 (6) -
RDoc
:: TopLevel (11)
モジュール
- RDoc (8)
-
RDoc
:: Text (8)
キーワード
- <=> (1)
- == (1)
-
ATTR
_ MODIFIERS (1) -
CLASS
_ MODIFIERS (1) -
CONSTANT
_ MODIFIERS (1) -
DEFAULT
_ EXTENSIONS (1) - DEPRECATED (1)
- DESCRIPTION (1)
-
DOT
_ DOC _ FILENAME (1) - EXTENSIONS (1)
-
GENERAL
_ MODIFIERS (1) -
GENERATOR
_ DIR (1) -
HTML
_ ENTITIES (1) -
KNOWN
_ CLASSES (1) -
LABEL
_ LIST _ RE (1) -
METHOD
_ MODIFIERS (1) - Markup (1)
- NORMAL (1)
- Options (1)
-
SEARCH
_ INDEX _ FILE (1) -
SIMPLE
_ LIST _ RE (1) - SINGLE (1)
- SPACE (1)
- SPECIAL (1)
- TYPES (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) -
can
_ parse (1) - charset (1)
- classes (1)
- comment (2)
- constants (1)
- content (1)
- convert (2)
-
coverage
_ report (1) -
coverage
_ report= (1) - css (2)
-
current
_ section (1) -
definition
_ lists (1) - diagram (1)
- document (1)
-
document
_ children (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)
- exclude (1)
- extension (2)
-
extra
_ accessor _ flags (1) -
extra
_ accessors (1) -
file
_ absolute _ name (1) -
file
_ relative _ name (1) -
file
_ stat (1) - fileboxes (1)
- files (1)
-
find
_ class _ named (1) -
find
_ enclosing _ module _ named (1) -
find
_ local _ symbol (1) -
find
_ module _ named (2) -
find
_ symbol (1) -
flush
_ left (1) -
force
_ output (1) -
force
_ update (1) - formatter (1)
-
full
_ name (1) - generate (3)
- generator (1)
-
get
_ line _ types (1) - github (1)
- html (1)
-
hyperlink
_ all (1) -
hyperlink
_ all= (1) -
image
_ format (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) - markup (2)
- merge (1)
-
method
_ list (1) - modules (1)
- name (1)
- new (16)
-
normalize
_ comment (1) - notes (1)
-
num
_ classes (1) -
num
_ files (1) -
num
_ methods (1) -
num
_ modules (1) -
op
_ dir (1) -
op
_ name (1) -
option
_ parser (1) -
page
_ dir (1) -
page
_ dir= (1) - parent (2)
-
parent
_ file _ name (1) -
parent
_ name (1) - parse (4)
-
parse
_ files _ matching (1) -
parser
_ for (1) - parsers (1)
- pipe (1)
- print (1)
- quiet (1)
-
rdoc
_ include (1) -
remove
_ classes _ and _ modules (1) -
remove
_ methods _ etc (1) -
remove
_ private _ comments (1) - requires (1)
- reset (1)
- root (1)
- scan (6)
- section (1)
- sections (1)
- sequence (1)
-
set
_ comment (1) -
set
_ current _ section (1) -
set
_ visibility _ for (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) - title (2)
- toplevel (1)
-
unmatched
_ alias _ lists (1) - verbosity (1)
- visibility (2)
- warn (1)
- webcvs (1)
検索結果
先頭5件
-
RDoc
:: Options :: DEPRECATED -> {String -> String} (604.0) -
非推奨のオプションの一覧を返します。
非推奨のオプションの一覧を返します。 -
RDoc
:: Options # dry _ run -> bool (448.0) -
コマンドライン引数の --dry-run オプションを指定していた場合、true を返 します。--no-dry-run オプションを指定していた場合、false を返します。
コマンドライン引数の --dry-run オプションを指定していた場合、true を返
します。--no-dry-run オプションを指定していた場合、false を返します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # line _ numbers -> bool (448.0) -
コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返 します。
コマンドライン引数の --line-numbers オプションを指定していた場合、true
を返します。--no-line-numbers オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # include _ line _ numbers -> bool (400.0) -
コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。
コマンドライン引数の --include-line-numbers を指定していた場合に true
を返します。そうでない場合は false を返します。 -
RDoc
:: Options # inline _ source -> bool (400.0) -
コマンドライン引数の --inline-source オプションか --one-file を指定して いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --inline-source オプションか --one-file を指定して
いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Markup # add _ special(pattern , name) -> () (358.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
:: Options # all _ one _ file -> bool (352.0) -
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。 -
RDoc
:: Options # coverage _ report -> Integer | false (352.0) -
コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。
コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # force _ output -> bool (352.0) -
コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返 します。
コマンドライン引数の --force_output オプションを指定していた場合、true
を返します。--no-force_output オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は true を返します。 -
RDoc
:: Options # hyperlink _ all -> bool (352.0) -
コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。
コマンドライン引数の --hyperlink-all オプションを指定していた場合、
true を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # image _ format -> String (352.0) -
コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。
コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。
指定しなかった場合は 'png' を返します。 -
RDoc
:: Options # page _ dir -> Pathname | nil (352.0) -
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し ます。
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し
ます。
指定されていない場合は nil を返します。 -
RDoc
:: Options # show _ hash -> bool (352.0) -
コマンドライン引数の --show-hash オプションを指定していた場合、true を 返します。そうでない場合は false を返します。
コマンドライン引数の --show-hash オプションを指定していた場合、true を
返します。そうでない場合は false を返します。 -
RDoc
:: Options # static _ path -> [String] (352.0) -
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し ます。
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。 -
RDoc
:: Options # tab _ width -> Integer (352.0) -
コマンドライン引数の --tab-width オプションで指定した数値を返します。
コマンドライン引数の --tab-width オプションで指定した数値を返します。 -
RDoc
:: Options :: SPECIAL -> [String] (352.0) -
--write-options を指定した際に .rdoc_options ファイルに保存されないオプ ションの一覧を返します。
...--write-options を指定した際に .rdoc_options ファイルに保存されないオプ
ションの一覧を返します。... -
RDoc
:: Options # op _ dir -> String (340.0) -
コマンドライン引数の --op オプションで指定したディレクトリを返します。
コマンドライン引数の --op オプションで指定したディレクトリを返します。
--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。
@return 設定されたディレクトリを文字列で返します。 -
RDoc
:: ATTR _ MODIFIERS -> [String] (307.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: CLASS _ MODIFIERS -> [String] (307.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: CONSTANT _ MODIFIERS -> [String] (307.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: Context # <=>(other) -> -1 | 0 | 1 (307.0) -
自身と other の full_name を比較した結果を返します。
自身と other の full_name を比較した結果を返します。
ソートのために使われます。
@param other 自身と比較したいオブジェクトを指定します。 -
RDoc
:: DOT _ DOC _ FILENAME -> " . document" (307.0) -
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。
...
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。... -
RDoc
:: GENERAL _ MODIFIERS -> [String] (307.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: METHOD _ MODIFIERS -> [String] (307.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: VERSION -> String (307.0) -
RDoc のバージョンを表す文字列を返します。
...
RDoc のバージョンを表す文字列を返します。... -
RDoc
:: CodeObject # comment -> String (304.0) -
自身のコメントを返します。
自身のコメントを返します。 -
RDoc
:: CodeObject # document _ children -> bool (304.0) -
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを返します。
...自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを返します。
@see RDoc::CodeObject#document_self... -
RDoc
:: CodeObject # document _ self -> bool (304.0) -
自身をドキュメントに含めるかどうかを返します。
...自身をドキュメントに含めるかどうかを返します。
@see RDoc::CodeObject#document_children... -
RDoc
:: CodeObject # documented? -> bool (304.0) -
出力すべきドキュメントがあるかどうかを返します。
出力すべきドキュメントがあるかどうかを返します。 -
RDoc
:: CodeObject # metadata -> Hash (304.0) -
自身が持つメタデータ(他から任意の値を設定してもよい)を返します。
自身が持つメタデータ(他から任意の値を設定してもよい)を返します。 -
RDoc
:: CodeObject # parent -> RDoc :: CodeObject (304.0) -
自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。
自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。 -
RDoc
:: CodeObject # parent _ file _ name -> String (304.0) -
self.parent のファイル名を返します。
...self.parent のファイル名を返します。
@see RDoc::CodeObject#parent... -
RDoc
:: CodeObject # parent _ name -> String (304.0) -
self.parent の名前を返します。
...self.parent の名前を返します。
@see RDoc::CodeObject#parent... -
RDoc
:: CodeObject # remove _ classes _ and _ modules -> () (304.0) -
何もしません。RDoc::CodeObject#document_children= に false を指定 した時のコールバックとして呼び出されます。オーバーライドして使用します。
...何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。... -
RDoc
:: CodeObject # remove _ methods _ etc -> () (304.0) -
何もしません。RDoc::CodeObject#document_self= に false を指定した 時のコールバックとして呼び出されます。オーバーライドして使用します。
...何もしません。RDoc::CodeObject#document_self= に false を指定した
時のコールバックとして呼び出されます。オーバーライドして使用します。... -
RDoc
:: CodeObject # section -> RDoc :: Context :: Section (304.0) -
所属している section を返します。
所属している section を返します。 -
RDoc
:: CodeObject # start _ doc -> () (304.0) -
以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで の間、ドキュメントに含めます。
...たコメントを RDoc::CodeObject#stop_doc を呼び出すまで
の間、ドキュメントに含めます。
:startdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を true に設定します。
@see RDoc::CodeObject#end_d... -
RDoc
:: CodeObject # stop _ doc -> () (304.0) -
以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま での間、ドキュメントに含めません。
...コメントを RDoc::CodeObject#start_doc を呼び出すま
での間、ドキュメントに含めません。
:stopdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を false に設定します。
@see RDoc::CodeObject#star... -
RDoc
:: CodeObject . new -> RDoc :: CodeObject (304.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Context # add _ alias(an _ alias) -> RDoc :: Alias (304.0) -
引数で指定した RDoc::Alias オブジェクトを追加します。
...引数で指定した RDoc::Alias オブジェクトを追加します。
@param an_alias RDoc::Alias オブジェクトを指定します。... -
RDoc
:: Context # add _ attribute(an _ attribute) -> () (304.0) -
引数で指定した RDoc::Attr オブジェクトを追加します。
...引数で指定した RDoc::Attr オブジェクトを追加します。
@param an_attribute RDoc::Attr オブジェクトを指定します。... -
RDoc
:: Context # add _ class(class _ type , name , superclass) -> RDoc :: SingleClass | RDoc :: NormalClass (304.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 (304.0) -
collection に name で指定したクラス、モジュールを追加します。
...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass......オ
ブジェクトで指定します。
既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。... -
RDoc
:: Context # add _ constant(const) -> () (304.0) -
引数で指定した RDoc::Constant オブジェクトを追加します。
...引数で指定した RDoc::Constant オブジェクトを追加します。
@param const RDoc::Constant オブジェクトを指定します。... -
RDoc
:: Context # add _ include(an _ include) -> () (304.0) -
引数で指定した RDoc::Include オブジェクトを追加します。
...引数で指定した RDoc::Include オブジェクトを追加します。
@param an_include RDoc::Include オブジェクトを指定します。... -
RDoc
:: Context # add _ method(a _ method) -> () (304.0) -
引数で指定した RDoc::AnyMethod オブジェクトを追加します。
...引数で指定した RDoc::AnyMethod オブジェクトを追加します。
@param a_method RDoc::AnyMethod オブジェクトかそのサブクラスのオ
ブジェクトを指定します。... -
RDoc
:: Context # add _ module(class _ type , name) -> RDoc :: NormalModule | RDoc :: SingleClass | RDoc :: NormalClass (304.0) -
引数で指定したモジュールを追加します。
...ram class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@see RDoc::Context#add_class... -
RDoc
:: Context # add _ require(a _ require) -> () (304.0) -
自身が所属する RDoc::TopLevel オブジェクトに引数で指定した RDoc::Require を追加します。
...自身が所属する RDoc::TopLevel オブジェクトに引数で指定した
RDoc::Require を追加します。
@param a_require RDoc::Require オブジェクトを指定します。... -
RDoc
:: Context # add _ to(array , thing) -> () (304.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] (304.0) -
追加された RDoc::Alias の配列を返します。
...追加された RDoc::Alias の配列を返します。... -
RDoc
:: Context # attributes -> [RDoc :: Attr] (304.0) -
追加された RDoc::Attr の配列を返します。
...追加された RDoc::Attr の配列を返します。... -
RDoc
:: Context # classes -> [RDoc :: SingleClass | RDoc :: NormalClass] (304.0) -
追加されたクラスの配列を返します。
追加されたクラスの配列を返します。 -
RDoc
:: Context # constants -> [RDoc :: Constant] (304.0) -
追加された RDoc::Constant の配列を返します。
...追加された RDoc::Constant の配列を返します。... -
RDoc
:: Context # current _ section -> RDoc :: Context :: Section (304.0) -
現在の section を返します。
現在の section を返します。 -
RDoc
:: Context # each _ attribute {|a| . . . } -> [RDoc :: Attr] (304.0) -
追加された RDoc::Attr に対してブロックを評価します。
...追加された RDoc::Attr に対してブロックを評価します。... -
RDoc
:: Context # each _ classmodule {|m| . . . } -> [RDoc :: SingleClass | RDoc :: NormalClass | RDoc :: NormalModule] (304.0) -
追加されたクラス、モジュールに対してブロックを評価します。
...追加されたクラス、モジュールに対してブロックを評価します。
@see RDoc::Context#classes, RDoc::Context#modules... -
RDoc
:: Context # each _ constant {|c| . . . } -> [RDoc :: Constant] (304.0) -
追加された RDoc::Constant に対してブロックを評価します。
...追加された RDoc::Constant に対してブロックを評価します。... -
RDoc
:: Context # each _ method {|m| . . . } -> [RDoc :: AnyMethod] (304.0) -
追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト) に対してブロックを評価します。
...追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト)
に対してブロックを評価します。... -
RDoc
:: Context # find _ enclosing _ module _ named(name) -> RDoc :: NormalModule | nil (304.0) -
find a module at a higher scope
find a module at a higher scope -
RDoc
:: Context # find _ module _ named(name) -> RDoc :: NormalModule | nil (304.0) -
追加された RDoc::NormalModule から引数で指定した名前のモジュール を検索します。見つからなかった場合は nil を返します。
...追加された RDoc::NormalModule から引数で指定した名前のモジュール
を検索します。見つからなかった場合は nil を返します。
@param name モジュールの名前を文字列で指定します。... -
RDoc
:: Context # includes -> [RDoc :: Include] (304.0) -
追加された RDoc::Include の配列を返します。
...追加された RDoc::Include の配列を返します。... -
RDoc
:: Context # initialize _ classes _ and _ modules -> () (304.0) -
追加されたクラスやモジュールをクリアします。
追加されたクラスやモジュールをクリアします。 -
RDoc
:: Context # initialize _ methods _ etc -> () (304.0) -
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて いないものを含む)、require されたファイル、include されたファイル、定数 をクリアします。
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて
いないものを含む)、require されたファイル、include されたファイル、定数
をクリアします。 -
RDoc
:: Context # method _ list -> [RDoc :: AnyMethod] (304.0) -
追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列 を返します。
...追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列
を返します。... -
RDoc
:: Context # modules -> [RDoc :: NormalModule] (304.0) -
追加された RDoc::NormalModule の配列を返します。
...追加された RDoc::NormalModule の配列を返します。... -
RDoc
:: Context # name -> String (304.0) -
自身の名前を返します。
自身の名前を返します。
サブクラスによっては、メソッド名やクラス名を意味します。 -
RDoc
:: Context # requires -> [RDoc :: Require] (304.0) -
追加された RDoc::Require の配列を返します。
...追加された RDoc::Require の配列を返します。... -
RDoc
:: Context # sections -> RDoc :: Context :: Section (304.0) -
追加された RDoc::Context::Section の配列を返します。
...追加された RDoc::Context::Section の配列を返します。... -
RDoc
:: Context # set _ current _ section(title , comment) -> () (304.0) -
Handle sections
Handle sections -
RDoc
:: Context # set _ visibility _ for(methods , visibility , singleton = false) -> () (304.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 (304.0) -
自身が所属する RDoc::TopLevel オブジェクトを返します。
...自身が所属する RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Context # unmatched _ alias _ lists -> {String => RDoc :: Alias} (304.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。
...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。... -
RDoc
:: Context # visibility -> :public | :protected | :private (304.0) -
自身の可視性を Symbol で返します。
自身の可視性を Symbol で返します。 -
RDoc
:: Context . new -> RDoc :: Context (304.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Context :: Section # ==(other) -> bool (304.0) -
自身と other のシーケンス番号を比較した結果を返します。
...自身と other のシーケンス番号を比較した結果を返します。
@param other RDoc::Context::Section オブジェクトを指定します。... -
RDoc
:: Context :: Section # comment -> String | nil (304.0) -
section のコメントを返します。
section のコメントを返します。 -
RDoc
:: Context :: Section # inspect -> String (304.0) -
自身の情報を人間に読みやすい文字列にして返します。
自身の情報を人間に読みやすい文字列にして返します。 -
RDoc
:: Context :: Section # parent -> RDoc :: Context (304.0) -
自身が所属する RDoc::Context オブジェクトを返します。
...自身が所属する RDoc::Context オブジェクトを返します。... -
RDoc
:: Context :: Section # sequence -> String (304.0) -
section のシーケンス番号を文字列で返します。
section のシーケンス番号を文字列で返します。
リンクを作成する時に使われます。 -
RDoc
:: Context :: Section # set _ comment(comment) -> () (304.0) -
自身にコメントを設定します。
自身にコメントを設定します。
@param comment 文字列を指定します。
comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。
# ---------------------
# :section: The title
# The body
# --------------------- -
RDoc
:: Context :: Section # title -> String | nil (304.0) -
section のタイトルを返します。
section のタイトルを返します。 -
RDoc
:: Context :: Section . new(parent , title , comment) -> RDoc :: Context :: Section (304.0) -
自身を初期化します。
...自身を初期化します。
@param parent RDoc::Context オブジェクトを指定します。
@param title section のタイトルを文字列で指定します。
@param comment section のコメントを文字列で指定します。
また、section のシーケンス番号を新しく... -
RDoc
:: Context :: TYPES -> ["class" , "instance"] (304.0) -
メソッドの種類を文字列の配列で返します。
メソッドの種類を文字列の配列で返します。 -
RDoc
:: Context :: VISIBILITIES -> [:public , :protected , :private] (304.0) -
メソッドの可視性を Symbol の配列で返します。
メソッドの可視性を Symbol の配列で返します。 -
RDoc
:: Generator :: Darkfish # generate -> () (304.0) -
解析した情報を HTML ファイルや検索用のインデックスに出力します。
解析した情報を HTML ファイルや検索用のインデックスに出力します。 -
RDoc
:: Generator :: Darkfish # initialize(store , options) -> RDoc :: Generator :: Darkfish (304.0) -
RDoc::Generator::Darkfish オブジェクトを初期化します。
...
RDoc::Generator::Darkfish オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。... -
RDoc
:: Generator :: Darkfish :: GENERATOR _ DIR -> String (304.0) -
このファイルの親ディレクトリへのパスを表す文字列です。
このファイルの親ディレクトリへのパスを表す文字列です。
テンプレートなどのリソースを検索するのに内部で使用します。 -
RDoc
:: Generator :: Darkfish :: VERSION -> & # 39;3& # 39; (304.0) -
darkfish のバージョンです。
darkfish のバージョンです。 -
RDoc
:: Generator :: JsonIndex # generate -> () (304.0) -
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出 力します。
...解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。... -
RDoc
:: Generator :: JsonIndex . new(parent _ generator , options) -> RDoc :: Generator :: JsonIndex (304.0) -
RDoc::Generator::JsonIndex オブジェクトを初期化します。
...
RDoc::Generator::JsonIndex オブジェクトを初期化します。
@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します......。
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。
@param options RDoc::Options オブジェクトを指定します。
parent_generator に渡されたものと同... -
RDoc
:: Generator :: JsonIndex :: SEARCH _ INDEX _ FILE -> String (304.0) -
検索インデックスのパスを表す文字列です。
検索インデックスのパスを表す文字列です。 -
RDoc
:: Generator :: RI # generate -> () (304.0) -
解析した情報を ri コマンドから読めるようにファイルに出力します。
解析した情報を ri コマンドから読めるようにファイルに出力します。 -
RDoc
:: Generator :: RI # initialize(store , options) -> RDoc :: Generator :: RI (304.0) -
RDoc::Generator::RI オブジェクトを初期化します。
...
RDoc::Generator::RI オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。... -
RDoc
:: Generator :: RI :: DESCRIPTION -> String (304.0) -
このジェネレータの説明を表す文字列です。
このジェネレータの説明を表す文字列です。 -
RDoc
:: KNOWN _ CLASSES -> {String => String} (304.0) -
Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
...Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"
ライブラリの内部で使用します。... -
RDoc
:: Markdown # break _ on _ newline -> bool (304.0) -
改行を保持した状態で出力するかどうかを返します。
改行を保持した状態で出力するかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # css -> bool (304.0) -
CSS を記述した場合に出力に含めるかどうかを返します。
CSS を記述した場合に出力に含めるかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # definition _ lists -> bool (304.0) -
定義リストを解釈するかどうかを返します。
定義リストを解釈するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # extension(name , enable) -> () (304.0) -
引数 name で指定した拡張の有効/無効を設定します。
引数 name で指定した拡張の有効/無効を設定します。
@param name 拡張の名前を Symbol で指定します。
@param enable 有効にする場合は true を、無効にする場合は false を指定し
ます。 -
RDoc
:: Markdown # github -> bool (304.0) -
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し ます。
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し
ます。
デフォルトでは true を返します。