ライブラリ
- rake (1)
-
rake
/ rdoctask (22) - rdoc (7)
-
rdoc
/ any _ method (1) -
rdoc
/ attr (1) -
rdoc
/ code _ object (20) -
rdoc
/ constant (1) -
rdoc
/ context (55) -
rdoc
/ generator (1) -
rdoc
/ generator / darkfish (5) -
rdoc
/ generator / json _ index (4) -
rdoc
/ generator / markup (1) -
rdoc
/ generator / ri (4) -
rdoc
/ ghost _ method (1) -
rdoc
/ known _ classes (1) -
rdoc
/ markdown (16) -
rdoc
/ markdown / entities (1) -
rdoc
/ markup (10) -
rdoc
/ markup / formatter (4) -
rdoc
/ markup / to _ ansi (2) -
rdoc
/ markup / to _ bs (2) -
rdoc
/ markup / to _ html (2) -
rdoc
/ markup / to _ html _ crossref (2) -
rdoc
/ markup / to _ rdoc (2) -
rdoc
/ parser (3) -
rdoc
/ parser / c (2) -
rdoc
/ parser / changelog (1) -
rdoc
/ parser / markdown (1) -
rdoc
/ parser / rd (1) -
rdoc
/ parser / ruby (3) -
rdoc
/ parser / ruby _ tools (1) -
rdoc
/ parser / simple (3) -
rdoc
/ parser / text (1) -
rdoc
/ rdoc (2) -
rdoc
/ stats (11) -
rdoc
/ text (9) -
rdoc
/ token _ stream (1) -
rdoc
/ top _ level (15) -
rubygems
/ doc _ manager (6) -
rubygems
/ exceptions (1) -
rubygems
/ server (1) -
rubygems
/ specification (7)
クラス
-
Gem
:: DocManager (6) -
Gem
:: Server (1) -
Gem
:: Specification (7) -
RDoc
:: CodeObject (19) -
RDoc
:: Context (45) -
RDoc
:: Context :: Section (8) -
RDoc
:: Generator :: Darkfish (4) -
RDoc
:: Generator :: JsonIndex (3) -
RDoc
:: Generator :: RI (3) -
RDoc
:: Markdown (17) -
RDoc
:: Markup (10) -
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 (3) -
RDoc
:: Parser :: C (2) -
RDoc
:: Parser :: ChangeLog (1) -
RDoc
:: Parser :: Markdown (1) -
RDoc
:: Parser :: RD (1) -
RDoc
:: Parser :: Ruby (2) -
RDoc
:: Parser :: Simple (3) -
RDoc
:: RDoc (2) -
RDoc
:: Stats (10) -
RDoc
:: TopLevel (14) -
Rake
:: RDocTask (21)
モジュール
-
Gem
:: InstallUpdateOptions (1) - Kernel (1)
- RDoc (8)
-
RDoc
:: Text (8)
キーワード
- <=> (1)
- == (1)
-
ATTR
_ MODIFIERS (1) - AnyMethod (1)
- Attr (1)
-
CLASS
_ MODIFIERS (1) -
CONSTANT
_ MODIFIERS (1) - CodeObject (1)
- Constant (1)
- Context (1)
-
DEFAULT
_ EXTENSIONS (1) - DEPRECATED (1)
- DESCRIPTION (1)
-
DOT
_ DOC _ FILENAME (1) - Darkfish (1)
- DocumentError (1)
- EXTENSIONS (1)
- Formatter (1)
-
GENERAL
_ MODIFIERS (1) -
GENERATOR
_ DIR (1) - Generator (1)
- GhostMethod (1)
-
HTML
_ ENTITIES (1) - JsonIndex (1)
-
KNOWN
_ CLASSES (1) -
LABEL
_ LIST _ RE (1) -
METHOD
_ MODIFIERS (1) - Markup (1)
- MetaMethod (1)
-
NEWS for Ruby 2
. 0 . 0 (1) -
NEWS for Ruby 2
. 2 . 0 (1) -
NEWS for Ruby 2
. 3 . 0 (1) -
NEWS for Ruby 2
. 4 . 0 (1) -
NEWS for Ruby 3
. 1 . 0 (1) - Options (1)
-
RDOC
_ CSS (1) - RDocTask (1)
- RI (1)
- RubyToken (1)
- RubyTools (1)
-
SEARCH
_ INDEX _ FILE (1) -
SIMPLE
_ LIST _ RE (1) - SPECIAL (1)
- Section (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)
- 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 (2)
- 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
_ 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)
-
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)
- new (18)
-
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 (4)
-
parse
_ files _ matching (1) -
parser
_ for (1) - pipe (1)
- pipe= (1)
- print (1)
- promiscuous (1)
- quiet (1)
- quote (1)
-
rake
/ rdoctask (1) -
rb
_ scan _ args (1) -
rdoc
/ any _ method (1) -
rdoc
/ attr (1) -
rdoc
/ code _ object (1) -
rdoc
/ code _ objects (1) -
rdoc
/ constant (1) -
rdoc
/ context (1) -
rdoc
/ generator (1) -
rdoc
/ generator / darkfish (1) -
rdoc
/ generator / json _ index (1) -
rdoc
/ generator / markup (1) -
rdoc
/ generator / ri (1) -
rdoc
/ ghost _ method (1) -
rdoc
/ markdown / entities (1) -
rdoc
/ markup / formatter (1) -
rdoc
/ markup / to _ ansi (1) -
rdoc
/ markup / to _ bs (1) -
rdoc
/ markup / to _ html (1) -
rdoc
/ markup / to _ html _ crossref (1) -
rdoc
/ markup / to _ rdoc (1) -
rdoc
/ parser / c (1) -
rdoc
/ parser / ruby (1) -
rdoc
/ parser / ruby _ tools (1) -
rdoc
/ parser / text (1) -
rdoc
/ stats (1) -
rdoc
/ text (1) -
rdoc
/ token _ stream (1) -
rdoc
/ top _ level (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)
- reset (1)
- root (1)
- root= (1)
-
ruby 1
. 8 . 2 feature (1) -
ruby 1
. 8 . 4 feature (1) -
rubygems
/ commands / install _ command (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) -
update
_ ri _ cache (1) - verbosity (1)
- verbosity= (1)
- visibility (2)
- visibility= (1)
- warn (1)
- webcvs (1)
- 正規表現 (1)
検索結果
先頭5件
-
Gem
:: Specification # has _ rdoc? -> bool (27418.0) -
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。
@see Gem::Specification#has_rdoc -
RDoc
:: CodeObject # start _ doc -> () (27403.0) -
以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで の間、ドキュメントに含めます。
以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで
の間、ドキュメントに含めます。
:startdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を true に設定します。
@see RDoc::CodeObject#end_doc -
RDoc
:: CodeObject # stop _ doc -> () (27403.0) -
以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま での間、ドキュメントに含めません。
以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま
での間、ドキュメントに含めません。
:stopdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を false に設定します。
@see RDoc::CodeObject#start_doc -
Gem
:: Specification # has _ rdoc -> bool (27400.0) -
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。 -
RDoc
:: TopLevel . reset -> () (27397.0) -
RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイ ル)をクリアします。
RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイ
ル)をクリアします。 -
RDoc
:: Text # normalize _ comment(text) -> String (27373.0) -
引数から行頭のスペースや改行文字などを削除します。
引数から行頭のスペースや改行文字などを削除します。
詳しくは [SEE ALSO] の各メソッドを参照してください。
@param text 文字列を指定します。
@see RDoc::Text#strip_hashes, RDoc::Text#expand_tabs,
RDoc::Text#flush_left, RDoc::Text#strip_newlines -
RDoc
:: Context # add _ constant(const) -> () (27367.0) -
引数で指定した RDoc::Constant オブジェクトを追加します。
引数で指定した RDoc::Constant オブジェクトを追加します。
@param const RDoc::Constant オブジェクトを指定します。 -
RDoc
:: Context # unmatched _ alias _ lists=(val) (27367.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を設定します。
メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を設定します。
@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。 -
Rake
:: RDocTask # options -> Array (27367.0) -
rdoc コマンドに渡すオプションのリストを返します。
rdoc コマンドに渡すオプションのリストを返します。
指定できるオプションは -o, --main, --title, -T 以外です。 -
Gem
:: Specification # has _ rdoc=(flag) (27352.0) -
RDoc を生成するかどうかをセットします。デフォルトは偽です。
RDoc を生成するかどうかをセットします。デフォルトは偽です。 -
RDoc
:: CodeObject # remove _ methods _ etc -> () (27349.0) -
何もしません。RDoc::CodeObject#document_self= に false を指定した 時のコールバックとして呼び出されます。オーバーライドして使用します。
何もしません。RDoc::CodeObject#document_self= に false を指定した
時のコールバックとして呼び出されます。オーバーライドして使用します。 -
RDoc
:: Generator :: JsonIndex # generate -> () (27349.0) -
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出 力します。
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。 -
RDoc
:: Markdown :: HTML _ ENTITIES -> {String => [Integer]} (27349.0) -
HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。
HTML の実体参照のマッピングを表す Hash オブジェクトです。
RDoc::Markdown で使用します。 -
RDoc
:: Text # expand _ tabs(text) -> String (27349.0) -
引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな るように置き換えます。
引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな
るように置き換えます。
@param text 文字列を指定します。 -
Rake
:: RDocTask # external -> bool (27349.0) -
この値が真の場合は外部のシェル経由で rdoc コマンドを実行します。 デフォルトは偽です。
この値が真の場合は外部のシェル経由で rdoc コマンドを実行します。
デフォルトは偽です。 -
Rake
:: RDocTask # external=(flag) (27349.0) -
外部のシェル経由で rdoc コマンドを実行するかどうかセットします。
外部のシェル経由で rdoc コマンドを実行するかどうかセットします。
@param flag 真または偽を指定します。 -
Rake
:: RDocTask # option _ list -> Array (27349.0) -
rdoc コマンドに渡すオプションのリストを返します。
rdoc コマンドに渡すオプションのリストを返します。 -
Rake
:: RDocTask # option _ string -> String (27349.0) -
rdoc コマンドに渡すオプションを文字列として返します。
rdoc コマンドに渡すオプションを文字列として返します。 -
Rake
:: RDocTask # title -> String (27349.0) -
RDoc のタイトルを返します。 デフォルト値はありません。
RDoc のタイトルを返します。
デフォルト値はありません。 -
RDoc
:: CodeObject (27337.0) -
RDoc のコードツリーを表現するクラスの基本クラスです。
RDoc のコードツリーを表現するクラスの基本クラスです。
以下は RDoc::CodeObject のサブクラスのツリーです。
//emlist{
* RDoc::Context
* RDoc::TopLevel
* RDoc::ClassModule
* RDoc::AnonClass
* RDoc::NormalClass
* RDoc::NormalModule
* RDoc::SingleClass
* RDoc::AnyMethod
* RDoc::GhostMethod
* RDoc::MetaMethod
... -
RDoc
:: CodeObject # document _ children=(val) (27337.0) -
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを設定します。
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを設定します。
:nodoc:、:stopdoc: を指定した時に false が設定されます。
@param val true を指定した場合、上記をドキュメントに含めます。
@see RDoc::CodeObject#document_self=,
RDoc::CodeObject#remove_classes_and_modules -
RDoc
:: CodeObject # document _ self=(val) (27337.0) -
自身をドキュメントに含めるかどうかを設定します。
自身をドキュメントに含めるかどうかを設定します。
:doc: を指定した時に true が設定されます。
:nodoc:、:stopdoc: を指定した時に false が設定されます。
@param val true を指定した場合、自身をドキュメントに含めます。
@see RDoc::CodeObject#document_children=,
RDoc::CodeObject#remove_methods_etc -
RDoc
:: Markup # add _ html(tag , name) -> () (27337.0) -
tag で指定したタグをフォーマットの対象にします。
tag で指定したタグをフォーマットの対象にします。
@param tag 追加するタグ名を文字列で指定します。大文字、小文字のど
ちらを指定しても同一のものとして扱われます。
@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
例:
require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_ht... -
RDoc
:: Parser # parse _ files _ matching(regexp) -> () (27337.0) -
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、
自身を登録します。
@param regexp 正規表現を指定します。
新しいパーサを作成する時に使用します。
例:
class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end -
Gem
:: InstallUpdateOptions # install _ update _ defaults _ str -> String (27319.0) -
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
デフォルトのオプションは以下の通りです。
--rdoc --no-force --no-test --wrappers -
RDoc
:: CodeObject # document _ children -> bool (27319.0) -
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを返します。
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを返します。
@see RDoc::CodeObject#document_self -
RDoc
:: CodeObject # document _ self -> bool (27319.0) -
自身をドキュメントに含めるかどうかを返します。
自身をドキュメントに含めるかどうかを返します。
@see RDoc::CodeObject#document_children -
RDoc
:: CodeObject # parent=(val) (27319.0) -
自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。
自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。
@param val RDoc::CodeObject のサブクラスのオブジェクトを指定しま
す。 -
RDoc
:: CodeObject # parent _ file _ name -> String (27319.0) -
self.parent のファイル名を返します。
self.parent のファイル名を返します。
@see RDoc::CodeObject#parent -
RDoc
:: CodeObject # parent _ name -> String (27319.0) -
self.parent の名前を返します。
self.parent の名前を返します。
@see RDoc::CodeObject#parent -
RDoc
:: CodeObject # section=(val) (27319.0) -
所属する section を設定します。
所属する section を設定します。
@param val RDoc::Context::Section オブジェクトを指定します。 -
RDoc
:: Markup # content -> String (27319.0) -
変換する文字列を返します。
変換する文字列を返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる事があります。
@see SM::SimpleMarkup#convert -
RDoc
:: Markup # get _ line _ types -> [Symbol] (27319.0) -
変換する文字列の各行のタイプを Symbol の配列で返します。
変換する文字列の各行のタイプを Symbol の配列で返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
@see SM::SimpleMarkup#convert -
RDoc
:: Options # verbosity=(val) (27319.0) -
プログラムの解析時に表示する情報の詳細さを数値で指定します。
プログラムの解析時に表示する情報の詳細さを数値で指定します。
@param val 何も表示しない場合は 0、通常の表示を行う場合は 1、詳細な表示
を行う場合は 2 を指定します。
@see RDoc::Options#verbosity -
RDoc
:: CodeObject # comment -> String (27301.0) -
自身のコメントを返します。
自身のコメントを返します。 -
RDoc
:: CodeObject # comment=(comment) (27301.0) -
自身のコメントを comment に設定します。
自身のコメントを comment に設定します。
ただし、comment が空文字列だった場合は何もしません。
@param comment コメントを文字列で指定します。 -
RDoc
:: CodeObject # documented? -> bool (27301.0) -
出力すべきドキュメントがあるかどうかを返します。
出力すべきドキュメントがあるかどうかを返します。 -
RDoc
:: Context # initialize _ classes _ and _ modules -> () (27301.0) -
追加されたクラスやモジュールをクリアします。
追加されたクラスやモジュールをクリアします。 -
RDoc
:: Context # initialize _ methods _ etc -> () (27301.0) -
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて いないものを含む)、require されたファイル、include されたファイル、定数 をクリアします。
追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて
いないものを含む)、require されたファイル、include されたファイル、定数
をクリアします。 -
RDoc
:: Context # ongoing _ visibility=(vis) (27301.0) -
Change the default visibility for new methods
Change the default visibility for new methods -
RDoc
:: Context # record _ location(toplevel) (27301.0) -
Record the file that we happen to find it in
Record the file that we happen to find it in -
RDoc
:: Context # visibility -> :public | :protected | :private (27301.0) -
自身の可視性を Symbol で返します。
自身の可視性を Symbol で返します。 -
RDoc
:: Context :: Section # comment -> String | nil (27301.0) -
section のコメントを返します。
section のコメントを返します。 -
RDoc
:: Context :: Section # inspect -> String (27301.0) -
自身の情報を人間に読みやすい文字列にして返します。
自身の情報を人間に読みやすい文字列にして返します。 -
RDoc
:: Context :: Section # set _ comment(comment) -> () (27301.0) -
自身にコメントを設定します。
自身にコメントを設定します。
@param comment 文字列を指定します。
comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。
# ---------------------
# :section: The title
# The body
# --------------------- -
RDoc
:: Context :: Section # title -> String | nil (27301.0) -
section のタイトルを返します。
section のタイトルを返します。 -
RDoc
:: Context :: TYPES -> ["class" , "instance"] (27301.0) -
メソッドの種類を文字列の配列で返します。
メソッドの種類を文字列の配列で返します。 -
RDoc
:: Context :: VISIBILITIES -> [:public , :protected , :private] (27301.0) -
メソッドの可視性を Symbol の配列で返します。
メソッドの可視性を Symbol の配列で返します。 -
RDoc
:: Generator :: Darkfish # generate -> () (27301.0) -
解析した情報を HTML ファイルや検索用のインデックスに出力します。
解析した情報を HTML ファイルや検索用のインデックスに出力します。 -
RDoc
:: Generator :: RI # generate -> () (27301.0) -
解析した情報を ri コマンドから読めるようにファイルに出力します。
解析した情報を ri コマンドから読めるようにファイルに出力します。 -
RDoc
:: Generator :: RI :: DESCRIPTION -> String (27301.0) -
このジェネレータの説明を表す文字列です。
このジェネレータの説明を表す文字列です。 -
RDoc
:: Markdown # definition _ lists -> bool (27301.0) -
定義リストを解釈するかどうかを返します。
定義リストを解釈するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # definition _ lists=(val) (27301.0) -
定義リストを解釈するかどうかを設定します。
定義リストを解釈するかどうかを設定します。 -
RDoc
:: Markdown # extension(name , enable) -> () (27301.0) -
引数 name で指定した拡張の有効/無効を設定します。
引数 name で指定した拡張の有効/無効を設定します。
@param name 拡張の名前を Symbol で指定します。
@param enable 有効にする場合は true を、無効にする場合は false を指定し
ます。 -
RDoc
:: Markdown # extension?(name) (27301.0) -
引数 name で指定した拡張が有効かどうかを返します。
引数 name で指定した拡張が有効かどうかを返します。
@param name 拡張の名前を Symbol で指定します。 -
RDoc
:: Markdown # github -> bool (27301.0) -
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し ます。
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し
ます。
デフォルトでは true を返します。 -
RDoc
:: Markdown # github=(val) (27301.0) -
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定 します。
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定
します。 -
RDoc
:: Markdown # html -> bool (27301.0) -
HTML を記述した場合にそのまま出力するかどうかを返します。
HTML を記述した場合にそのまま出力するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # html=(val) (27301.0) -
HTML を記述した場合にそのまま出力するかどうかを設定します。
HTML を記述した場合にそのまま出力するかどうかを設定します。 -
RDoc
:: Markdown # notes -> bool (27301.0) -
脚注の出力を有効にするかどうかを返します。
脚注の出力を有効にするかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # notes=(val) (27301.0) -
脚注の出力を有効にするかどうかを設定します。
脚注の出力を有効にするかどうかを設定します。 -
RDoc
:: Markdown . extension(name) -> nil (27301.0) -
引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定 義します。
引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定
義します。
ライブラリ内部で使用します。 -
RDoc
:: Markdown :: DEFAULT _ EXTENSIONS -> [Symbol] (27301.0) -
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。 -
RDoc
:: Markdown :: EXTENSIONS -> [Symbol] (27301.0) -
サポートする拡張の一覧を Symbol の配列で返します。
サポートする拡張の一覧を Symbol の配列で返します。 -
RDoc
:: Markup # convert(str , formatter) -> object | "" (27301.0) -
str で指定された文字列を formatter に変換させます。
str で指定された文字列を formatter に変換させます。
@param str 変換する文字列を指定します。
@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。
変換結果は formatter によって文字列や配列を返します。 -
RDoc
:: Markup :: Formatter # convert(content) -> () (27301.0) -
content で指定された文字列を変換します。
content で指定された文字列を変換します。
@param content 変換する文字列を指定します。 -
RDoc
:: Markup :: LABEL _ LIST _ RE -> Regexp (27301.0) -
ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。
ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。 -
RDoc
:: Markup :: SIMPLE _ LIST _ RE -> Regexp (27301.0) -
リストにマッチする正規表現です。ライブラリの内部で使用します。
リストにマッチする正規表現です。ライブラリの内部で使用します。
ラベルの有無を問わずマッチします。 -
RDoc
:: Options # charset -> String (27301.0) -
コマンドライン引数の --charset オプションで指定した文字コードを文字列で 返します。
コマンドライン引数の --charset オプションで指定した文字コードを文字列で
返します。
指定しなかった場合は、$KCODE に応じた値になります。 -
RDoc
:: Options # coverage _ report -> Integer | false (27301.0) -
コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。
コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # coverage _ report=(val) (27301.0) -
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
@param val 数値オブジェクトか false を指定します。 -
RDoc
:: Options # extra _ accessors -> Regexp | nil (27301.0) -
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ てにマッチする正規表現オブジェクトを返します。
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # force _ output -> bool (27301.0) -
コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返 します。
コマンドライン引数の --force_output オプションを指定していた場合、true
を返します。--no-force_output オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は true を返します。 -
RDoc
:: Options # force _ output=(val) (27301.0) -
val に true を指定した場合、コマンドライン引数の --force_output オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。
@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # force _ update -> bool (27301.0) -
コマンドライン引数の --force_update を指定していた場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --force_update を指定していた場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # formatter -> nil (27301.0) -
使用されていません。常に nil を返します。
使用されていません。常に nil を返します。 -
RDoc
:: Options # formatter=(val) (27301.0) -
使用されていません。
使用されていません。 -
RDoc
:: Options # generator=(val) (27301.0) -
コマンドライン引数の --fmt オプションと同様の指定を行います。
コマンドライン引数の --fmt オプションと同様の指定を行います。
@param val 設定する Generator を指定します。 -
RDoc
:: Options # image _ format -> String (27301.0) -
コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。
コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。
指定しなかった場合は 'png' を返します。 -
RDoc
:: Options # quiet -> bool (27301.0) -
コマンドライン引数の --quiet オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
コマンドライン引数の --quiet オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。 -
RDoc
:: Options # root -> Pathname (27301.0) -
コマンドライン引数の --root オプションで指定したディレクトリを返します。
コマンドライン引数の --root オプションで指定したディレクトリを返します。
指定されていない場合はカレントディレクトリを返します。 -
RDoc
:: Options # root=(val) (27301.0) -
コマンドライン引数の --root オプションと同様の指定を行います。
コマンドライン引数の --root オプションと同様の指定を行います。
@param val パスを文字列で指定します。 -
RDoc
:: Options # tab _ width -> Integer (27301.0) -
コマンドライン引数の --tab-width オプションで指定した数値を返します。
コマンドライン引数の --tab-width オプションで指定した数値を返します。 -
RDoc
:: Options # verbosity -> 0 | 1 | 2 (27301.0) -
プログラムの解析時に表示する情報の詳細さを数値で返します。
プログラムの解析時に表示する情報の詳細さを数値で返します。
以下の値を指定する事ができます。
: 0(--quiet オプションを指定した場合)
情報を表示しません。
: 1
通常の表示を行います。
: 2(--verbose オプションを指定した場合)
詳細な情報を表示します。 -
RDoc
:: Options # visibility -> :public | :protected | :private (27301.0) -
コマンドライン引数の --visibility で指定したオプションを Symbol で返します。
コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。 -
RDoc
:: Options # visibility=(val) (27301.0) -
コマンドライン引数の --visibility オプションと同様の指定を行います。
コマンドライン引数の --visibility オプションと同様の指定を行います。
@param val :public、:protected、:private のいずれかを指定します。 -
RDoc
:: Options :: DEPRECATED -> {String -> String} (27301.0) -
非推奨のオプションの一覧を返します。
非推奨のオプションの一覧を返します。 -
RDoc
:: Parser . alias _ extension(old _ ext , new _ ext) -> bool (27301.0) -
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登 録します。
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登
録します。
@param old_ext 拡張子を文字列で指定します。
@param new_ext 拡張子を文字列で指定します。
@return エイリアスが登録された場合は true を返します。old_ext にパーサ
が登録されていない場合、エイリアスが登録されずに false を返しま
す。 -
RDoc
:: Parser :: Simple # remove _ private _ comments(comment) -> String (27301.0) -
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返 します。
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。
@param comment 対象の文字列を指定します。
@return コメントが削除された文字列を返します。 -
RDoc
:: Stats # num _ methods -> Integer (27301.0) -
解析したメソッドの数を返します。
解析したメソッドの数を返します。 -
RDoc
:: Stats # num _ methods=(val) (27301.0) -
解析したメソッドの数を指定します。
解析したメソッドの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # print -> () (27301.0) -
自身の持つ情報を標準出力に表示します。
自身の持つ情報を標準出力に表示します。 -
RDoc
:: Text # flush _ left(text) -> String (27301.0) -
引数から各行の行頭のスペースを削除します。
引数から各行の行頭のスペースを削除します。
@param text 文字列を指定します。 -
RDoc
:: TopLevel # file _ absolute _ name -> String (27301.0) -
自身が管理するファイルに関する絶対パスを文字列で返します。
自身が管理するファイルに関する絶対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ absolute _ name=(val) (27301.0) -
自身が管理するファイルに関する絶対パスを文字列で設定します。
自身が管理するファイルに関する絶対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ relative _ name -> String (27301.0) -
自身が管理するファイルに関する相対パスを文字列で返します。
自身が管理するファイルに関する相対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ relative _ name=(val) (27301.0) -
自身が管理するファイルに関する相対パスを文字列で設定します。
自身が管理するファイルに関する相対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ stat=(val) (27301.0) -
自身が管理するファイルに関する File::Stat オブジェクトを設定しま す。
自身が管理するファイルに関する File::Stat オブジェクトを設定しま
す。
@param val File::Stat オブジェクトを指定します。 -
Rake
:: RDocTask # quote(str) -> String (27301.0) -
Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。
Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。
@param str クオートする文字列を指定します。 -
RDoc
:: Options (27283.0) -
rdoc コマンドのオプションを解析するためのクラスです。
rdoc コマンドのオプションを解析するためのクラスです。
それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。
===[a:custom_options] カスタムオプション
RDoc のジェネレータでは、RDoc::Options をフックして独自の
オプションを指定できます。
Object::ARGV に --format が含まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要が...