ライブラリ
-
rake
/ rdoctask (4) - rdoc (2)
-
rdoc
/ anon _ class (1) -
rdoc
/ code _ object (2) -
rdoc
/ constant (1) -
rdoc
/ context (55) -
rdoc
/ generator / darkfish (2) -
rdoc
/ generator / json _ index (4) -
rdoc
/ generator / ri (2) -
rdoc
/ markdown (10) -
rdoc
/ markup (2) -
rdoc
/ markup / formatter (1) -
rdoc
/ markup / to _ html _ crossref (1) -
rdoc
/ parser (2) -
rdoc
/ parser / c (1) -
rdoc
/ parser / ruby (1) -
rdoc
/ parser / simple (1) -
rdoc
/ top _ level (2) -
rubygems
/ doc _ manager (2) -
rubygems
/ specification (7)
クラス
-
Gem
:: DocManager (2) -
Gem
:: Specification (7) -
RDoc
:: CodeObject (2) -
RDoc
:: Context (45) -
RDoc
:: Context :: Section (8) -
RDoc
:: Generator :: Darkfish (2) -
RDoc
:: Generator :: JsonIndex (3) -
RDoc
:: Generator :: RI (2) -
RDoc
:: Markdown (10) -
RDoc
:: Markup (2) -
RDoc
:: Markup :: Formatter (1) -
RDoc
:: Markup :: ToHtmlCrossref (1) -
RDoc
:: Options (72) -
RDoc
:: Parser (2) -
RDoc
:: Parser :: C (1) -
RDoc
:: Parser :: Ruby (1) -
RDoc
:: Parser :: Simple (1) -
RDoc
:: TopLevel (2) -
Rake
:: RDocTask (4)
モジュール
-
Gem
:: InstallUpdateOptions (1) - RDoc (2)
キーワード
- <=> (1)
- == (1)
- AnonClass (1)
-
CONSTANT
_ MODIFIERS (1) - Constant (1)
- Context (1)
-
DEFAULT
_ EXTENSIONS (1) - DEPRECATED (1)
- DESCRIPTION (1)
- EXTENSIONS (1)
- JsonIndex (1)
-
NEWS for Ruby 2
. 0 . 0 (1) -
NEWS for Ruby 2
. 4 . 0 (1) - Options (1)
-
SEARCH
_ INDEX _ FILE (1) - SPECIAL (1)
- Section (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
_ include (1) -
add
_ method (1) -
add
_ module (1) -
add
_ require (1) -
add
_ to (1) -
alias
_ extension (1) - aliases (1)
-
all
_ one _ file (1) - attributes (1)
-
break
_ on _ newline (1) -
break
_ on _ newline= (1) -
cgi
/ session (1) - charset (1)
- classes (1)
- comment (1)
-
configured
_ args (1) -
configured
_ args= (1) - constants (1)
- content (1)
- convert (2)
-
coverage
_ report (1) -
coverage
_ report= (1) - css (1)
-
current
_ section (1) -
defined
_ in? (1) -
definition
_ lists (1) -
definition
_ lists= (1) - diagram (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) -
extra
_ rdoc _ files (1) -
extra
_ rdoc _ files= (1) - fileboxes (1)
- files (1)
-
find
_ enclosing _ module _ named (1) -
find
_ local _ symbol (2) -
find
_ module _ named (1) -
find
_ symbol (1) -
finish
_ page _ dir (1) -
force
_ output (1) -
force
_ output= (1) -
force
_ update (1) - formatter (1)
- formatter= (1)
- generate (1)
- generator (1)
- generator= (1)
-
has
_ rdoc (1) -
has
_ rdoc= (1) -
has
_ rdoc? (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
_ update _ defaults _ str (1) -
line
_ numbers (1) -
line
_ numbers= (1) -
main
_ page (1) -
main
_ page= (1) - markup (1)
- markup= (1)
- merge (1)
-
method
_ list (1) - modules (1)
- name (1)
- new (8)
-
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 (1)
- parse (1)
-
parser
_ for (1) - pipe (1)
- pipe= (1)
- promiscuous (1)
- quiet (1)
-
rb
_ scan _ args (1) -
rdoc
/ anon _ class (1) -
rdoc
/ constant (1) -
rdoc
/ context (1) -
rdoc
/ generator / json _ index (1) -
rdoc
/ markdown (1) -
rdoc
_ include (1) -
record
_ location (1) - requires (1)
- root (1)
- root= (1)
-
ruby 1
. 8 . 2 feature (1) -
ruby 1
. 8 . 4 feature (1) -
rubygems
/ commands / server _ command (1) -
sanitize
_ path (1) - 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) -
static
_ path (1) -
static
_ path= (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)
- 正規表現 (1)
検索結果
先頭5件
-
rdoc (115123.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。
このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ... -
RDoc
:: VERSION -> String (69349.0) -
RDoc のバージョンを表す文字列を返します。
RDoc のバージョンを表す文字列を返します。 -
RDoc
:: CONSTANT _ MODIFIERS -> [String] (69301.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
Gem
:: Specification # rdoc _ options=(options) (45970.0) -
API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。
API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。
@param options API ドキュメントを生成するときに rdoc コマンドに与えるオプションを指定します。 -
Gem
:: Specification # rdoc _ options -> [String] (45652.0) -
API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。
API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。 -
RDoc
:: Context # sections -> RDoc :: Context :: Section (37252.0) -
追加された RDoc::Context::Section の配列を返します。
追加された RDoc::Context::Section の配列を返します。 -
RDoc
:: Context # current _ section -> RDoc :: Context :: Section (37204.0) -
現在の section を返します。
現在の section を返します。 -
RDoc
:: Context # constants -> [RDoc :: Constant] (36952.0) -
追加された RDoc::Constant の配列を返します。
追加された RDoc::Constant の配列を返します。 -
RDoc
:: Context # each _ constant {|c| . . . } -> [RDoc :: Constant] (36952.0) -
追加された RDoc::Constant に対してブロックを評価します。
追加された RDoc::Constant に対してブロックを評価します。 -
RDoc
:: Context # add _ constant(const) -> () (36667.0) -
引数で指定した RDoc::Constant オブジェクトを追加します。
引数で指定した RDoc::Constant オブジェクトを追加します。
@param const RDoc::Constant オブジェクトを指定します。 -
RDoc
:: Options # option _ parser -> OptionParser | nil (36601.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。
コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。 -
RDoc
:: Options # write _ options -> object (36349.0) -
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式 で保存します。
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式
で保存します。 -
RDoc
:: Options # rdoc _ include -> [String] (36304.0) -
コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。
コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。
指定しなかった場合は ['.'] を返します。 -
RDoc
:: Context # ongoing _ visibility=(vis) (36301.0) -
Change the default visibility for new methods
Change the default visibility for new methods -
RDoc
:: Context # record _ location(toplevel) (36301.0) -
Record the file that we happen to find it in
Record the file that we happen to find it in -
RDoc
:: Context # set _ current _ section(title , comment) -> () (36301.0) -
Handle sections
Handle sections -
RDoc
:: Options # all _ one _ file -> bool (36301.0) -
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。 -
RDoc
:: Options # option _ parser=(val) (36301.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。
コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。
@param val OptionParser オブジェクトを指定します。 -
rdoc
/ context (36097.0) -
RDoc::Context と RDoc::Context::Section を定義するサブライ ブラリです。
RDoc::Context と RDoc::Context::Section を定義するサブライ
ブラリです。 -
rdoc
/ anon _ class (36049.0) -
RDoc::AnonClass を定義するサブライブラリです。
RDoc::AnonClass を定義するサブライブラリです。 -
rdoc
/ constant (36049.0) -
RDoc::Constant を定義するサブライブラリです。
RDoc::Constant を定義するサブライブラリです。 -
rdoc
/ options (36049.0) -
rdoc コマンドのオプションを解析するためのサブライブラリです。
rdoc コマンドのオプションを解析するためのサブライブラリです。 -
rdoc
/ generator / json _ index (36037.0) -
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ クスを生成するサブライブラリです。
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するサブライブラリです。
This generator is derived from sdoc by Vladimir Kolesnikov and
contains verbatim code written by him.
このジェネレータは HTML ジェネレータと一緒に使うために設計されています。:
class RDoc::Generator::Darkfish
def initialize options
# ...
@base_dir = Pa... -
RDoc
:: Context :: Section (36001.0) -
section に関する情報を保持するクラスです。
section に関する情報を保持するクラスです。
ドキュメント中で以下のように記述した情報を保持しています。
# :section: The title
# The body -
RDoc
:: CodeObject # section -> RDoc :: Context :: Section (28204.0) -
所属している section を返します。
所属している section を返します。 -
RDoc
:: Context :: Section . new(parent , title , comment) -> RDoc :: Context :: Section (27922.0) -
自身を初期化します。
自身を初期化します。
@param parent RDoc::Context オブジェクトを指定します。
@param title section のタイトルを文字列で指定します。
@param comment section のコメントを文字列で指定します。
また、section のシーケンス番号を新しく作成します。 -
Rake
:: RDocTask # options=(options) (27667.0) -
rdoc コマンドに渡すオプションのリストをセットします。
rdoc コマンドに渡すオプションのリストをセットします。
@param options rdoc コマンドに渡されるオプションを指定します。 -
RDoc
:: Context :: Section # parent -> RDoc :: Context (27652.0) -
自身が所属する RDoc::Context オブジェクトを返します。
自身が所属する RDoc::Context オブジェクトを返します。 -
RDoc
:: Markup :: Formatter # convert(content) -> () (27601.0) -
content で指定された文字列を変換します。
content で指定された文字列を変換します。
@param content 変換する文字列を指定します。 -
Gem
:: Specification # has _ rdoc? -> bool (27418.0) -
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。
@see Gem::Specification#has_rdoc -
Gem
:: Specification # has _ rdoc -> bool (27400.0) -
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。 -
Gem
:: Specification # extra _ rdoc _ files=(paths) (27370.0) -
RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。
RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。
@param paths RDoc でドキュメントを作成する際に使用する特別なファイルのリストを指定します。 -
Gem
:: Specification # extra _ rdoc _ files -> [String] (27352.0) -
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。 -
Gem
:: Specification # has _ rdoc=(flag) (27352.0) -
RDoc を生成するかどうかをセットします。デフォルトは偽です。
RDoc を生成するかどうかをセットします。デフォルトは偽です。 -
Rake
:: RDocTask # option _ list -> Array (27349.0) -
rdoc コマンドに渡すオプションのリストを返します。
rdoc コマンドに渡すオプションのリストを返します。 -
Rake
:: RDocTask # option _ string -> String (27349.0) -
rdoc コマンドに渡すオプションを文字列として返します。
rdoc コマンドに渡すオプションを文字列として返します。 -
Rake
:: RDocTask # options -> Array (27349.0) -
rdoc コマンドに渡すオプションのリストを返します。
rdoc コマンドに渡すオプションのリストを返します。
指定できるオプションは -o, --main, --title, -T 以外です。 -
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
:: Markdown # break _ on _ newline -> bool (27304.0) -
改行を保持した状態で出力するかどうかを返します。
改行を保持した状態で出力するかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # break _ on _ newline=(val) (27304.0) -
改行を保持した状態で出力するかどうかを設定します。
改行を保持した状態で出力するかどうかを設定します。 -
RDoc
:: Generator :: Darkfish :: VERSION -> & # 39;3& # 39; (27301.0) -
darkfish のバージョンです。
darkfish のバージョンです。 -
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 . 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
:: Options (27301.0) -
rdoc コマンドのオプションを解析するためのクラスです。
rdoc コマンドのオプションを解析するためのクラスです。
それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。
===[a:custom_options] カスタムオプション
RDoc のジェネレータでは、RDoc::Options をフックして独自の
オプションを指定できます。
Object::ARGV に --format が含まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要が... -
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
:: Context (27049.0) -
モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す るクラスを管理するクラスです。
モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す
るクラスを管理するクラスです。 -
RDoc
:: Context :: Section # ==(other) -> bool (27019.0) -
自身と other のシーケンス番号を比較した結果を返します。
自身と other のシーケンス番号を比較した結果を返します。
@param other RDoc::Context::Section オブジェクトを指定します。 -
RDoc
:: AnonClass (27001.0) -
匿名クラスを表現するクラスです。
匿名クラスを表現するクラスです。
現在は使用されていません。 -
RDoc
:: Constant (27001.0) -
定数を表現するクラスです。
定数を表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: Context :: Section # comment -> String | nil (27001.0) -
section のコメントを返します。
section のコメントを返します。 -
RDoc
:: Context :: Section # inspect -> String (27001.0) -
自身の情報を人間に読みやすい文字列にして返します。
自身の情報を人間に読みやすい文字列にして返します。 -
RDoc
:: Context :: Section # sequence -> String (27001.0) -
section のシーケンス番号を文字列で返します。
section のシーケンス番号を文字列で返します。
リンクを作成する時に使われます。 -
RDoc
:: Context :: Section # set _ comment(comment) -> () (27001.0) -
自身にコメントを設定します。
自身にコメントを設定します。
@param comment 文字列を指定します。
comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。
# ---------------------
# :section: The title
# The body
# --------------------- -
RDoc
:: Context :: Section # title -> String | nil (27001.0) -
section のタイトルを返します。
section のタイトルを返します。 -
RDoc
:: Generator :: JsonIndex (27001.0) -
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ クスを生成するクラスです。
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するクラスです。 -
RDoc
:: Context # add _ class _ or _ module(collection , class _ type , name , superclass = nil) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule (19300.0) -
collection に name で指定したクラス、モジュールを追加します。
collection に name で指定したクラス、モジュールを追加します。
@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param su... -
RDoc
:: Generator :: JsonIndex . new(parent _ generator , options) -> RDoc :: Generator :: JsonIndex (19006.0) -
RDoc::Generator::JsonIndex オブジェクトを初期化します。
RDoc::Generator::JsonIndex オブジェクトを初期化します。
@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します。
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。
@... -
RDoc
:: Context # add _ module(class _ type , name) -> RDoc :: NormalModule | RDoc :: SingleClass | RDoc :: NormalClass (18982.0) -
引数で指定したモジュールを追加します。
引数で指定したモジュールを追加します。
ただし、クラスとして既に同名のものが登録されていた場合は、何もせずにそ
のクラスを返します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@see RDoc::Context#add_class -
RDoc
:: Context # each _ classmodule {|m| . . . } -> [RDoc :: SingleClass | RDoc :: NormalClass | RDoc :: NormalModule] (18946.0) -
追加されたクラス、モジュールに対してブロックを評価します。
追加されたクラス、モジュールに対してブロックを評価します。
@see RDoc::Context#classes, RDoc::Context#modules -
RDoc
:: Context # add _ class(class _ type , name , superclass) -> RDoc :: SingleClass | RDoc :: NormalClass (18679.0) -
引数で指定したクラスを追加します。
引数で指定したクラスを追加します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass オ
ブジェクトで指定します。 -
RDoc
:: Context # classes -> [RDoc :: SingleClass | RDoc :: NormalClass] (18607.0) -
追加されたクラスの配列を返します。
追加されたクラスの配列を返します。 -
RDoc
:: Context . new -> RDoc :: Context (18604.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Context # set _ visibility _ for(methods , visibility , singleton = false) -> () (18433.0) -
methods で指定した RDoc::AnyMethod、RDoc::Attr の内、 singleton で指定した条件と一致するメソッドすべての可視性を visibility に設定します。
methods で指定した RDoc::AnyMethod、RDoc::Attr の内、
singleton で指定した条件と一致するメソッドすべての可視性を visibility
に設定します。
@param methods RDoc::AnyMethod、RDoc::Attr オブジェクトの配
列を指定します。
@param visibility 可視性を :public, :protected, :private の内のいずれか
で指定します。
@param singleton 特異メソッドの可視性を変更する場合は... -
RDoc
:: Context # add _ alias(an _ alias) -> RDoc :: Alias (18370.0) -
引数で指定した RDoc::Alias オブジェクトを追加します。
引数で指定した RDoc::Alias オブジェクトを追加します。
@param an_alias RDoc::Alias オブジェクトを指定します。 -
RDoc
:: Context # aliases -> [RDoc :: Alias] (18352.0) -
追加された RDoc::Alias の配列を返します。
追加された RDoc::Alias の配列を返します。 -
RDoc
:: Context # attributes -> [RDoc :: Attr] (18352.0) -
追加された RDoc::Attr の配列を返します。
追加された RDoc::Attr の配列を返します。 -
RDoc
:: Context # each _ attribute {|a| . . . } -> [RDoc :: Attr] (18352.0) -
追加された RDoc::Attr に対してブロックを評価します。
追加された RDoc::Attr に対してブロックを評価します。 -
RDoc
:: Context # each _ method {|m| . . . } -> [RDoc :: AnyMethod] (18352.0) -
追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト) に対してブロックを評価します。
追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト)
に対してブロックを評価します。 -
RDoc
:: Context # find _ module _ named(name) -> RDoc :: NormalModule | nil (18352.0) -
追加された RDoc::NormalModule から引数で指定した名前のモジュール を検索します。見つからなかった場合は nil を返します。
追加された RDoc::NormalModule から引数で指定した名前のモジュール
を検索します。見つからなかった場合は nil を返します。
@param name モジュールの名前を文字列で指定します。 -
RDoc
:: Context # includes -> [RDoc :: Include] (18352.0) -
追加された RDoc::Include の配列を返します。
追加された RDoc::Include の配列を返します。 -
RDoc
:: Context # method _ list -> [RDoc :: AnyMethod] (18352.0) -
追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列 を返します。
追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列
を返します。 -
RDoc
:: Context # modules -> [RDoc :: NormalModule] (18352.0) -
追加された RDoc::NormalModule の配列を返します。
追加された RDoc::NormalModule の配列を返します。 -
RDoc
:: Context # requires -> [RDoc :: Require] (18352.0) -
追加された RDoc::Require の配列を返します。
追加された RDoc::Require の配列を返します。 -
RDoc
:: Context # toplevel -> RDoc :: TopLevel (18352.0) -
自身が所属する RDoc::TopLevel オブジェクトを返します。
自身が所属する RDoc::TopLevel オブジェクトを返します。 -
RDoc
:: Context # unmatched _ alias _ lists -> {String => RDoc :: Alias} (18352.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。
メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。 -
Gem
:: DocManager . configured _ args -> Array (18349.0) -
RDoc に渡す引数を返します。
RDoc に渡す引数を返します。 -
Gem
:: DocManager . configured _ args=(args) (18349.0) -
RDoc に渡す引数をセットします。
RDoc に渡す引数をセットします。
@param args 文字列の配列か空白区切りの文字列を指定します。 -
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
/ markdown (18301.0) -
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための サブライブラリです。
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
サブライブラリです。
詳しくは以下を参照してください。
* https://daringfireball.net/projects/markdown/syntax
Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考に プロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。
=== 拡張
以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効にな... -
RDoc
:: Context # add _ to(array , thing) -> () (18127.0) -
array に thing を追加します。
array に thing を追加します。
@param array 配列を指定します。
@param 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_requ... -
RDoc
:: Context # add _ require(a _ require) -> () (18115.0) -
自身が所属する RDoc::TopLevel オブジェクトに引数で指定した RDoc::Require を追加します。
自身が所属する RDoc::TopLevel オブジェクトに引数で指定した
RDoc::Require を追加します。
@param a_require RDoc::Require オブジェクトを指定します。 -
RDoc
:: Context # add _ attribute(an _ attribute) -> () (18067.0) -
引数で指定した RDoc::Attr オブジェクトを追加します。
引数で指定した RDoc::Attr オブジェクトを追加します。
@param an_attribute RDoc::Attr オブジェクトを指定します。 -
RDoc
:: Context # add _ include(an _ include) -> () (18067.0) -
引数で指定した RDoc::Include オブジェクトを追加します。
引数で指定した RDoc::Include オブジェクトを追加します。
@param an_include RDoc::Include オブジェクトを指定します。 -
RDoc
:: Context # add _ method(a _ method) -> () (18067.0) -
引数で指定した RDoc::AnyMethod オブジェクトを追加します。
引数で指定した RDoc::AnyMethod オブジェクトを追加します。
@param a_method RDoc::AnyMethod オブジェクトかそのサブクラスのオ
ブジェクトを指定します。 -
RDoc
:: Context # unmatched _ alias _ lists=(val) (18067.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を設定します。
メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を設定します。
@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。 -
RDoc
:: Generator :: JsonIndex # generate -> () (18049.0) -
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出 力します。
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。 -
RDoc
:: Options :: SPECIAL -> [String] (18049.0) -
--write-options を指定した際に .rdoc_options ファイルに保存されないオプ ションの一覧を返します。
--write-options を指定した際に .rdoc_options ファイルに保存されないオプ
ションの一覧を返します。 -
RDoc
:: Options # markup -> String (18019.0) -
コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。
コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。
指定されていない場合は 'rdoc' を返します。 -
RDoc
:: Options # verbosity=(val) (18019.0) -
プログラムの解析時に表示する情報の詳細さを数値で指定します。
プログラムの解析時に表示する情報の詳細さを数値で指定します。
@param val 何も表示しない場合は 0、通常の表示を行う場合は 1、詳細な表示
を行う場合は 2 を指定します。
@see RDoc::Options#verbosity -
cgi
/ session (18019.0) -
CGI のセッション管理を行うライブラリ。
CGI のセッション管理を行うライブラリ。
セッションとは、HTTP の一連のリクエストとレスポンスが属するべき
コンテクスト (状況) のことをいいます。
セッション管理には従来通り cgi ライブラリが提供する
クッキーを使用してもいいですが、
この cgi/session を使用した方がよりわかりやすいでしょう。
セッション情報は Hash ライクなインターフェースです。
セッションはセッション ID とプログラムが記録した
セッション情報から構成されます。
デフォルトでは CGI::Session::FileStore が使用され、
記録できるのは文字列のみです。
セッション情報... -
RDoc
:: Context # <=>(other) -> -1 | 0 | 1 (18001.0) -
自身と other の full_name を比較した結果を返します。
自身と other の full_name を比較した結果を返します。
ソートのために使われます。
@param other 自身と比較したいオブジェクトを指定します。 -
RDoc
:: Context # defined _ in?(file) (18001.0) -
Return true if at least part of this thing was defined in file
Return true if at least part of this thing was defined in file