種類
- インスタンスメソッド (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
:: Generator :: Markup (4.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: Generator :: RI (4.0) -
ri のためのファイルを生成するためのクラスです。
ri のためのファイルを生成するためのクラスです。 -
RDoc
:: Generator :: RI # generate -> () (4.0) -
解析した情報を ri コマンドから読めるようにファイルに出力します。
解析した情報を ri コマンドから読めるようにファイルに出力します。 -
RDoc
:: Generator :: RI # initialize(store , options) -> RDoc :: Generator :: RI (4.0) -
RDoc::Generator::RI オブジェクトを初期化します。
...
RDoc::Generator::RI オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。... -
RDoc
:: Generator :: RI :: DESCRIPTION -> String (4.0) -
このジェネレータの説明を表す文字列です。
このジェネレータの説明を表す文字列です。 -
RDoc
:: GhostMethod (4.0) -
コメントでのみ参照されるメソッドを表現します。
コメントでのみ参照されるメソッドを表現します。
ライブラリの内部で使用します。 -
RDoc
:: Include (4.0) -
includeされるファイルを表現します。
includeされるファイルを表現します。
ライブラリの内部で使用します。 -
RDoc
:: KNOWN _ CLASSES -> {String => String} (4.0) -
Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
...Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"
ライブラリの内部で使用します。... -
RDoc
:: Markdown (4.0) -
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための クラスです。
...Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
クラスです。... -
RDoc
:: Markdown # break _ on _ newline -> bool (4.0) -
改行を保持した状態で出力するかどうかを返します。
改行を保持した状態で出力するかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # break _ on _ newline=(val) (4.0) -
改行を保持した状態で出力するかどうかを設定します。
改行を保持した状態で出力するかどうかを設定します。 -
RDoc
:: Markdown # css -> bool (4.0) -
CSS を記述した場合に出力に含めるかどうかを返します。
CSS を記述した場合に出力に含めるかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # css=(val) (4.0) -
CSS を記述した場合に出力に含めるかどうかを設定します。
CSS を記述した場合に出力に含めるかどうかを設定します。 -
RDoc
:: Markdown # definition _ lists -> bool (4.0) -
定義リストを解釈するかどうかを返します。
定義リストを解釈するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # definition _ lists=(val) (4.0) -
定義リストを解釈するかどうかを設定します。
定義リストを解釈するかどうかを設定します。 -
RDoc
:: Markdown # extension(name , enable) -> () (4.0) -
引数 name で指定した拡張の有効/無効を設定します。
引数 name で指定した拡張の有効/無効を設定します。
@param name 拡張の名前を Symbol で指定します。
@param enable 有効にする場合は true を、無効にする場合は false を指定し
ます。 -
RDoc
:: Markdown # extension?(name) (4.0) -
引数 name で指定した拡張が有効かどうかを返します。
引数 name で指定した拡張が有効かどうかを返します。
@param name 拡張の名前を Symbol で指定します。 -
RDoc
:: Markdown # github -> bool (4.0) -
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し ます。
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し
ます。
デフォルトでは true を返します。 -
RDoc
:: Markdown # github=(val) (4.0) -
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定 します。
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定
します。 -
RDoc
:: Markdown # html -> bool (4.0) -
HTML を記述した場合にそのまま出力するかどうかを返します。
HTML を記述した場合にそのまま出力するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # html=(val) (4.0) -
HTML を記述した場合にそのまま出力するかどうかを設定します。
HTML を記述した場合にそのまま出力するかどうかを設定します。 -
RDoc
:: Markdown # notes -> bool (4.0) -
脚注の出力を有効にするかどうかを返します。
脚注の出力を有効にするかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # notes=(val) (4.0) -
脚注の出力を有効にするかどうかを設定します。
脚注の出力を有効にするかどうかを設定します。 -
RDoc
:: Markdown # parse(markdown) -> RDoc :: Markup :: Document (4.0) -
引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。
...引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。
@param markdown 解析の対象になるドキュメントを文字列で指定します。... -
RDoc
:: Markdown . extension(name) -> nil (4.0) -
引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定 義します。
引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定
義します。
ライブラリ内部で使用します。 -
RDoc
:: Markdown . new(extensions = DEFAULT _ EXTENSIONS , debug = false) (4.0) -
引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブ ジェクトを初期化します。
...引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブ
ジェクトを初期化します。
@param extensions 有効にする拡張を Symbol の配列で指定します。
@param debug デバッグを有効にするかどうかを指定します。... -
RDoc
:: Markdown . parse(markdown) -> RDoc :: Markup :: Document (4.0) -
引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。
...引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。
@param markdown 解析の対象になるドキュメントを文字列で指定します。... -
RDoc
:: Markdown :: DEFAULT _ EXTENSIONS -> [Symbol] (4.0) -
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。 -
RDoc
:: Markdown :: EXTENSIONS -> [Symbol] (4.0) -
サポートする拡張の一覧を Symbol の配列で返します。
サポートする拡張の一覧を Symbol の配列で返します。 -
RDoc
:: Markdown :: HTML _ ENTITIES -> {String => [Integer]} (4.0) -
HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。
...HTML の実体参照のマッピングを表す Hash オブジェクトです。
RDoc::Markdown で使用します。... -
RDoc
:: Markup (4.0) -
RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。
...RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。
例:
require 'rdoc/markup/to_html'
h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)
独自のフォーマットを行うようにパーサを拡張する事もできます。
例:
req......uire 'rdoc/markup'
require 'rdoc/markup/to_html'
class WikiHtml < RDoc::Markup::ToHtml
# WikiWord のフォントを赤く表示。
def handle_special_WIKIWORD(special)
"<font color=red>" + special.text + "</font>"
end
end
m = RDoc::Markup.new
# { 〜 } までを :STRIK......STRIKE のフォーマットを <strike> 〜 </strike> に指定。
wh.add_tag(:STRIKE, "<strike>", "</strike>")
puts "<body>#{wh.convert ARGF.read}</body>"
変換する形式を変更する場合、フォーマッタ(例. RDoc::Markup::ToHtml)
を変更、拡張する必要があります。... -
RDoc
:: Markup # add _ html(tag , name) -> () (4.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) -> () (4.0) -
pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま す。
...::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
例:
require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
class WikiHtml < SM::ToHtml
def handle_special_WIKIWORD(special)
"<font color=red>" +... -
RDoc
:: Markup # add _ word _ pair(start , stop , name) -> () (4.0) -
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。
...ます。
@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。
例:
require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_word_pair("{", "}", :STRIKE)
h = SM::ToHtml.new
h.add_tag(:S... -
RDoc
:: Markup # attribute _ manager -> RDoc :: AttributeManager (4.0) -
自身の RDoc::AttributeManager オブジェクトを返します。
...自身の RDoc::AttributeManager オブジェクトを返します。... -
RDoc
:: Markup # content -> String (4.0) -
変換する文字列を返します。
...変換する文字列を返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる... -
RDoc
:: Markup # convert(str , formatter) -> object | "" (4.0) -
str で指定された文字列を formatter に変換させます。
str で指定された文字列を formatter に変換させます。
@param str 変換する文字列を指定します。
@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。
変換結果は formatter によって文字列や配列を返します。 -
RDoc
:: Markup # get _ line _ types -> [Symbol] (4.0) -
変換する文字列の各行のタイプを Symbol の配列で返します。
...変換する文字列の各行のタイプを Symbol の配列で返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
@see SM::SimpleMarkup#convert... -
RDoc
:: Markup . new(attribute _ manager = nil) -> RDoc :: Markup (4.0) -
自身を初期化します。
...自身を初期化します。
@param attribute_manager Rdoc::AttributeManager オブジェクトを指
定します。... -
RDoc
:: Markup :: Formatter (4.0) -
RDoc 形式のドキュメントを整形するための基本クラスです。
...RDoc 形式のドキュメントを整形するための基本クラスです。
実際にドキュメントを整形するには、RDoc::Markup::ToHtml のような、
継承したクラスで convert メソッドを実行してください。... -
RDoc
:: Markup :: Formatter # add _ tag(name , start , stop) -> () (4.0) -
name で登録された規則で取得された文字列を start と stop で囲むように指 定します。
...@param name RDoc::Markup::ToHtml などのフォーマッタに識別させる時
の名前を Symbol で指定します。
@param start 開始の記号を文字列で指定します。
@param stop 終了の記号を文字列で指定します。
例:
require 'rdoc/markup/to_html......'
# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup::ToHtml.new
h.add_tag(:STRIKE, "<strike>", "</strike>")... -
RDoc
:: Markup :: Formatter # convert(content) -> () (4.0) -
content で指定された文字列を変換します。
content で指定された文字列を変換します。
@param content 変換する文字列を指定します。 -
RDoc
:: Markup :: Formatter . new(markup = nil) -> RDoc :: Markup :: Formatter (4.0) -
自身を初期化します。
...自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。... -
RDoc
:: Markup :: LABEL _ LIST _ RE -> Regexp (4.0) -
ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。
ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。 -
RDoc
:: Markup :: SIMPLE _ LIST _ RE -> Regexp (4.0) -
リストにマッチする正規表現です。ライブラリの内部で使用します。
リストにマッチする正規表現です。ライブラリの内部で使用します。
ラベルの有無を問わずマッチします。 -
RDoc
:: Markup :: SPACE -> ?\s (4.0) -
空白文字です。?\s を返します。ライブラリの内部で使用します。
空白文字です。?\s を返します。ライブラリの内部で使用します。 -
RDoc
:: Markup :: ToAnsi (4.0) -
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするクラスで す。
...RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするクラスで
す。... -
RDoc
:: Markup :: ToAnsi . new(markup = nil) -> RDoc :: Markup :: ToAnsi (4.0) -
自身を初期化します。
...自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。... -
RDoc
:: Markup :: ToBs (4.0) -
RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるクラスです。
...RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるクラスです。... -
RDoc
:: Markup :: ToBs . new(markup = nil) -> RDoc :: Markup :: ToBs (4.0) -
自身を初期化します。
...自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。... -
RDoc
:: Markup :: ToHtml (4.0) -
RDoc 形式のドキュメントを HTML に整形するクラスです。
...RDoc 形式のドキュメントを HTML に整形するクラスです。... -
RDoc
:: Markup :: ToHtml . new -> RDoc :: Markup :: ToHtml (4.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Markup :: ToHtmlCrossref (4.0) -
RDoc 形式のドキュメントを HTML に整形するクラスです。
...RDoc 形式のドキュメントを HTML に整形するクラスです。... -
RDoc
:: Markup :: ToHtmlCrossref . new(path , context , show _ hash) -> RDoc :: Markup :: ToHtmlCrossref (4.0) -
自身を初期化します。
...自身を初期化します。
@param path 生成するファイルのパスを文字列で指定します。
@param context RDoc::Context オブジェクトかそのサブクラスのオブジェ
クトを指定します。
@param show_hash true を指定した場合、メソッ... -
RDoc
:: Markup :: ToRdoc (4.0) -
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための クラスです。
...RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
クラスです。... -
RDoc
:: Markup :: ToRdoc . new(markup = nil) -> RDoc :: Markup :: ToRdoc (4.0) -
自身を初期化します。
...自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。... -
RDoc
:: MetaMethod (4.0) -
動的に定義されたメソッドを表現するクラスです。
動的に定義されたメソッドを表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: NormalClass (4.0) -
クラスを表現するためのクラスです。
クラスを表現するためのクラスです。
特異クラスや匿名クラスは含まれません。
ライブラリの内部で使用します。 -
RDoc
:: NormalModule (4.0) -
モジュールを表現するクラスです。
モジュールを表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: Options (4.0) -
rdoc コマンドのオプションを解析するためのクラスです。
...rdoc コマンドのオプションを解析するためのクラスです。
それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。
===[a:custom_options] カスタムオプション
RDoc のジェネレータでは、RDoc::Options をフックし......まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要があります。rdoc --help を実行する......ます。
例:
class RDoc::Generator::Spellcheck
RDoc::RDoc.add_generator self
def self.setup_options rdoc_options
op = rdoc_options.option_parser
op.on('--spell-dictionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_dicti... -
RDoc
:: Options # all _ one _ file -> bool (4.0) -
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。 -
RDoc
:: Options # charset -> String (4.0) -
コマンドライン引数の --charset オプションで指定した文字コードを文字列で 返します。
コマンドライン引数の --charset オプションで指定した文字コードを文字列で
返します。
指定しなかった場合は、$KCODE に応じた値になります。 -
RDoc
:: Options # coverage _ report -> Integer | false (4.0) -
コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。
コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # coverage _ report=(val) (4.0) -
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
@param val 数値オブジェクトか false を指定します。 -
RDoc
:: Options # css -> String (4.0) -
コマンドライン引数の --style オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --style オプションで指定した URL を文字列で返しま
す。 -
RDoc
:: Options # diagram -> bool (4.0) -
コマンドライン引数の --diagram オプションを指定していた場合、true を返 します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプションを指定していた場合、true を返
します。そうでない場合は false を返します。 -
RDoc
:: Options # dry _ run -> bool (4.0) -
コマンドライン引数の --dry-run オプションを指定していた場合、true を返 します。--no-dry-run オプションを指定していた場合、false を返します。
コマンドライン引数の --dry-run オプションを指定していた場合、true を返
します。--no-dry-run オプションを指定していた場合、false を返します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # dry _ run=(val) (4.0) -
val に true を指定した場合、コマンドライン引数の --dry-run オプションと 同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --dry-run オプションと
同様の指定を行います。
@param val --dry-run オプションと同じ指定を行う場合は true、そうでない
場合は false を指定します。 -
RDoc
:: Options # encoding -> Encoding (4.0) -
コマンドライン引数の --encoding オプションを指定していた場合、指定した エンコーディングに対応する Encoding オブジェクトを返します。
コマンドライン引数の --encoding オプションを指定していた場合、指定した
エンコーディングに対応する Encoding オブジェクトを返します。
指定しなかった場合は Encoding.default_external の値を返します。 -
RDoc
:: Options # encoding=(val) (4.0) -
コマンドライン引数の --encoding オプションと同様の指定を行います。
コマンドライン引数の --encoding オプションと同様の指定を行います。
@param val 設定する Encoding オブジェクトを指定します。 -
RDoc
:: Options # exclude -> Regexp (4.0) -
コマンドライン引数の --exclude オプションで指定した正規表現を返します。 複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた ものを返します。
コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。 -
RDoc
:: Options # exclude=(val) (4.0) -
コマンドライン引数の --exclude オプションと同様の指定を行います。
コマンドライン引数の --exclude オプションと同様の指定を行います。
@param val 設定するパターンを Regexp オブジェクトで指定します。 -
RDoc
:: Options # extra _ accessor _ flags -> {String => String} (4.0) -
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。
値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。 -
RDoc
:: Options # extra _ accessors -> Regexp | nil (4.0) -
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ てにマッチする正規表現オブジェクトを返します。
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # fileboxes -> bool (4.0) -
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定 していた場合、true を返します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定
していた場合、true を返します。そうでない場合は false を返します。 -
RDoc
:: Options # files -> [String] (4.0) -
解析するファイルの一覧を文字列の配列で返します。
解析するファイルの一覧を文字列の配列で返します。 -
RDoc
:: Options # finish _ page _ dir (4.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: Options # force _ output -> bool (4.0) -
コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返 します。
コマンドライン引数の --force_output オプションを指定していた場合、true
を返します。--no-force_output オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は true を返します。 -
RDoc
:: Options # force _ output=(val) (4.0) -
val に true を指定した場合、コマンドライン引数の --force_output オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。
@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # force _ update -> bool (4.0) -
コマンドライン引数の --force_update を指定していた場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --force_update を指定していた場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # formatter -> nil (4.0) -
使用されていません。常に nil を返します。
使用されていません。常に nil を返します。 -
RDoc
:: Options # formatter=(val) (4.0) -
使用されていません。
使用されていません。 -
RDoc
:: Options # generator -> Generator (4.0) -
コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。
コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。
指定しなかった場合は、HTML に対応する Generator を返します。 -
RDoc
:: Options # generator=(val) (4.0) -
コマンドライン引数の --fmt オプションと同様の指定を行います。
コマンドライン引数の --fmt オプションと同様の指定を行います。
@param val 設定する Generator を指定します。 -
RDoc
:: Options # hyperlink _ all -> bool (4.0) -
コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。
コマンドライン引数の --hyperlink-all オプションを指定していた場合、
true を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # hyperlink _ all=(val) (4.0) -
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ
ンと同様の指定を行います。
@param val --hyperlink-all オプションと同じ指定を行う場合は true、そう
でない場合は false を指定します。 -
RDoc
:: Options # image _ format -> String (4.0) -
コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。
コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。
指定しなかった場合は 'png' を返します。 -
RDoc
:: Options # include _ line _ numbers -> bool (4.0) -
コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。
コマンドライン引数の --include-line-numbers を指定していた場合に true
を返します。そうでない場合は false を返します。 -
RDoc
:: Options # inline _ source -> bool (4.0) -
コマンドライン引数の --inline-source オプションか --one-file を指定して いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --inline-source オプションか --one-file を指定して
いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # line _ numbers -> bool (4.0) -
コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返 します。
コマンドライン引数の --line-numbers オプションを指定していた場合、true
を返します。--no-line-numbers オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # line _ numbers=(val) (4.0) -
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ
ンと同様の指定を行います。
@param val --line-numbers オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # main _ page -> String | nil (4.0) -
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # main _ page=(val) (4.0) -
コマンドライン引数の --main オプションと同様の指定を行います。
コマンドライン引数の --main オプションと同様の指定を行います。
@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。 -
RDoc
:: Options # markup -> String (4.0) -
コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。
...コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。
指定されていない場合は 'rdoc' を返します。... -
RDoc
:: Options # markup=(val) (4.0) -
コマンドライン引数の --markup オプションと同様の指定を行います。
コマンドライン引数の --markup オプションと同様の指定を行います。
@param val フォーマットを文字列で指定します。 -
RDoc
:: Options # merge -> true | nil (4.0) -
コマンドライン引数の --merge オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
コマンドライン引数の --merge オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。 -
RDoc
:: Options # op _ dir -> String (4.0) -
コマンドライン引数の --op オプションで指定したディレクトリを返します。
コマンドライン引数の --op オプションで指定したディレクトリを返します。
--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。
@return 設定されたディレクトリを文字列で返します。 -
RDoc
:: Options # op _ dir=(val) (4.0) -
コマンドライン引数の --op オプションと同様の指定を行います。
コマンドライン引数の --op オプションと同様の指定を行います。
@param val 設定するディレクトリを文字列で指定します。 -
RDoc
:: Options # op _ name -> String (4.0) -
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま す。
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま
す。 -
RDoc
:: Options # option _ parser -> OptionParser | nil (4.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。
コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。