ライブラリ
- ビルトイン (3)
- rake (1)
-
rake
/ rdoctask (16) - rdoc (7)
-
rdoc
/ anon _ class (1) -
rdoc
/ any _ method (1) -
rdoc
/ code _ object (15) -
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
/ include (1) -
rdoc
/ known _ classes (1) -
rdoc
/ markdown (21) -
rdoc
/ markdown / entities (1) -
rdoc
/ markup (8) -
rdoc
/ markup / formatter (3) -
rdoc
/ markup / to _ ansi (2) -
rdoc
/ markup / to _ bs (1) -
rdoc
/ markup / to _ html (1) -
rdoc
/ markup / to _ html _ crossref (1) -
rdoc
/ markup / to _ rdoc (1) -
rdoc
/ normal _ class (1) -
rdoc
/ normal _ module (1) -
rdoc
/ parser (4) -
rdoc
/ parser / c (2) -
rdoc
/ parser / changelog (2) -
rdoc
/ parser / markdown (2) -
rdoc
/ parser / rd (1) -
rdoc
/ parser / ruby (5) -
rdoc
/ parser / simple (3) -
rdoc
/ rdoc (2) -
rdoc
/ single _ class (1) -
rdoc
/ stats (10) -
rdoc
/ text (8) -
rdoc
/ token _ stream (1) -
rdoc
/ top _ level (11) -
rubygems
/ commands / rdoc _ command (1) -
rubygems
/ doc _ manager (12) -
rubygems
/ exceptions (1) -
rubygems
/ server (1) -
rubygems
/ specification (7)
クラス
-
Gem
:: DocManager (11) -
Gem
:: Server (1) -
Gem
:: Specification (7) - Module (2)
-
RDoc
:: CodeObject (15) -
RDoc
:: Context (45) -
RDoc
:: Context :: Section (8) -
RDoc
:: Generator :: Darkfish (4) -
RDoc
:: Generator :: JsonIndex (3) -
RDoc
:: Generator :: RI (3) -
RDoc
:: Markdown (21) -
RDoc
:: Markup (8) -
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 (4) -
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 (10) -
RDoc
:: TopLevel (11) -
Rake
:: RDocTask (16)
モジュール
-
Gem
:: InstallUpdateOptions (1) - Kernel (1)
- RDoc (8)
-
RDoc
:: Text (8)
オブジェクト
- main (1)
キーワード
- <=> (1)
- == (1)
-
ATTR
_ MODIFIERS (1) - AnonClass (1)
- AnyMethod (1)
-
CLASS
_ MODIFIERS (1) -
CONSTANT
_ MODIFIERS (1) - ChangeLog (1)
- Constant (1)
- Context (1)
-
DEFAULT
_ EXTENSIONS (1) - DEPRECATED (1)
- DESCRIPTION (1)
-
DOT
_ DOC _ FILENAME (1) - Darkfish (1)
- DocManager (1)
- DocumentError (1)
- EXTENSIONS (1)
-
GENERAL
_ MODIFIERS (1) -
GENERATOR
_ DIR (1) - Generator (1)
-
HTML
_ ENTITIES (1) - Include (1)
- JsonIndex (1)
-
KNOWN
_ CLASSES (1) -
METHOD
_ MODIFIERS (1) - Markdown (2)
- Markup (1)
-
NEWS for Ruby 2
. 0 . 0 (1) -
NEWS for Ruby 2
. 1 . 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 2
. 5 . 0 (1) - NORMAL (1)
- NormalClass (1)
- NormalModule (1)
- Options (1)
-
RDOC
_ CSS (1) - RI (1)
- RdocCommand (1)
- RubyToken (1)
- Ruby用語集 (1)
-
SEARCH
_ INDEX _ FILE (1) - SINGLE (1)
- SPECIAL (1)
- Section (1)
- SingleClass (1)
- TYPES (1)
- ToAnsi (1)
- TokenStream (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) -
cgi
/ session (1) - charset (1)
- classes (1)
- comment (2)
- comment= (1)
-
configured
_ args (1) -
configured
_ args= (1) - constants (1)
- content (1)
- convert (2)
-
coverage
_ report (1) -
coverage
_ report= (1) - css (2)
- 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) - 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) -
load
_ rdoc (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 (19)
-
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)
-
rb
_ scan _ args (1) -
rdoc
/ anon _ class (1) -
rdoc
/ any _ method (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
/ include (1) -
rdoc
/ known _ classes (1) -
rdoc
/ markdown (1) -
rdoc
/ markdown / entities (1) -
rdoc
/ markup / to _ ansi (1) -
rdoc
/ normal _ class (1) -
rdoc
/ normal _ module (1) -
rdoc
/ parser / changelog (1) -
rdoc
/ parser / markdown (1) -
rdoc
/ single _ class (1) -
rdoc
/ token _ stream (1) -
rdoc
_ dir (1) -
rdoc
_ include (1) -
rdoc
_ installed? (1) -
record
_ location (1) - refine (1)
-
remove
_ classes _ and _ modules (1) -
remove
_ private _ comments (1) - requires (1)
- root (1)
- root= (1)
-
ruby 1
. 8 . 2 feature (1) -
ruby 1
. 8 . 4 feature (1) - rubygems (1)
-
rubygems
/ commands / install _ command (1) -
rubygems
/ commands / rdoc _ command (1) -
rubygems
/ commands / server _ command (1) -
rubygems
/ doc _ manager (1) -
run
_ rdoc (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) -
static
_ path (1) -
static
_ path= (1) -
strip
_ hashes (1) -
strip
_ newlines (1) -
strip
_ stars (1) -
tab
_ width (1) - template (2)
-
template
_ dir (1) -
template
_ dir= (1) - title (3)
- title= (1)
- toplevel (1)
-
uninstall
_ doc (1) -
unmatched
_ alias _ lists (1) -
unmatched
_ alias _ lists= (1) -
update
_ ri _ cache (1) - using (2)
- verbosity (1)
- verbosity= (1)
- visibility (2)
- visibility= (1)
- warn (1)
- webcvs (1)
- コマンド (1)
- 正規表現 (1)
検索結果
-
rdoc (115123.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。
このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ... -
NEWS for Ruby 2
. 0 . 0 (78181.0) -
NEWS for Ruby 2.0.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
NEWS for Ruby 2.0.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリストは ChangeLog ファイルか bugs.ruby-lang.org の issue を参照してください。
== 1.9.3 以降の変更
=== 言語仕様の変更
* キーワード引数を追加しました
* %i, %I をシンボルの配列作成のために追加しました。(%w, %W に似ています)
* デフォルトのソースエンコーディングを US-ASCI... -
NEWS for Ruby 2
. 1 . 0 (78091.0) -
NEWS for Ruby 2.1.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
NEWS for Ruby 2.1.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリストは ChangeLog ファイルか bugs.ruby-lang.org の issue を参照してください。
== 2.0.0 以降の変更
=== 言語仕様の変更
* キーワード引数のデフォルト値が省略可能になりました。これらの「必須キーワード引数」は呼び出し時に明示的に与えなければなりません。
* 整数や小数のリテラルの末尾に'r','i','... -
NEWS for Ruby 2
. 3 . 0 (78073.0) -
NEWS for Ruby 2.3.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
....rdoc#421--2015-12-22
* RubyGems
* RubyGems 2.5.1 に更新しました。
* http://docs.seattlerb.org/rubygems/History_txt.html#label-2.5.0+-2F+2015-11-03
* http://docs.seattlerb.org/rubygems/History_txt.html#label-2.5.1+-2F+2015-12-10
=== 組込みのグローバル変数の互... -
NEWS for Ruby 2
. 5 . 0 (78055.0) -
NEWS for Ruby 2.5.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
...NEWS for Ruby 2.5.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリス... -
NEWS for Ruby 2
. 2 . 0 (78037.0) -
NEWS for Ruby 2.2.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
NEWS for Ruby 2.2.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリストは ChangeLog ファイルか bugs.ruby-lang.org の issue を参照してください。
== 2.1.0 以降の変更
=== 言語仕様の変更
* nil/true/false
* nil/true/false はフリーズされました 8923
* Hash リテラル
* 後ろにコロンのあるシンボルをキーにしたと... -
NEWS for Ruby 2
. 4 . 0 (78037.0) -
NEWS for Ruby 2.4.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
NEWS for Ruby 2.4.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリストは ChangeLog ファイルか bugs.ruby-lang.org の issue を参照してください。
== 2.3.0 以降の変更
=== 言語仕様の変更
* 条件式での多重代入ができるようになりました 10617
* Symbol#to_proc でメソッド呼び出し元での Refinements が有効になりました 9451
* Ob... -
RDoc
:: DOT _ DOC _ FILENAME -> " . document" (69349.0) -
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。 -
RDoc
:: VERSION -> String (69349.0) -
RDoc のバージョンを表す文字列を返します。
RDoc のバージョンを表す文字列を返します。 -
ruby 1
. 8 . 4 feature (69307.0) -
ruby 1.8.4 feature ruby 1.8.4 での ruby 1.8.3 からの変更点です。
ruby 1.8.4 feature
ruby 1.8.4 での ruby 1.8.3 からの変更点です。
掲載方針
*バグ修正の影響も含めて動作が変わるものを収録する。
*単にバグを直しただけのものは収録しない。
*ライブラリへの単なる定数の追加は収録しない。
以下は各変更点に付けるべきタグです。
記号について(特に重要なものは大文字(主観))
# * カテゴリ
# * [ruby]: ruby インタプリタの変更
# * [api]: 拡張ライブラリ API
# * [lib]: ライブラリ
* レベル
* [bug]: バグ修正
* [new]: 追加され... -
RDoc
:: CONSTANT _ MODIFIERS -> [String] (69301.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: GENERAL _ MODIFIERS -> [String] (69301.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
ruby 1
. 8 . 2 feature (69073.0) -
ruby 1.8.2 feature ruby 1.8.2 での ruby 1.8.1 からの変更点です。
ruby 1.8.2 feature
ruby 1.8.2 での ruby 1.8.1 からの変更点です。
掲載方針
*バグ修正の影響も含めて動作が変わるものを収録する。
*単にバグを直しただけのものは収録しない。
*ライブラリへの単なる定数の追加は収録しない。
以下は各変更点に付けるべきタグです。
*カテゴリ
* [ruby]: ruby インタプリタの変更
* [api]: 拡張ライブラリ API
* [lib]: ライブラリ
*レベル
* [bug]: バグ修正
* [new]: 追加されたクラス/メソッドなど
* [compat]: 変更されたクラス/... -
rubygems
/ commands / rdoc _ command (54157.0) -
RDoc と ri のライブラリを生成するためのライブラリです。
RDoc と ri のライブラリを生成するためのライブラリです。
Usage: gem rdoc [args] [options]
Options:
--all インストールされている全ての Gem パッケージの
RDoc/RI ドキュメントを生成します。
--[no-]rdoc RDoc を含めます
--[no-]ri RI ... -
RDoc
:: ATTR _ MODIFIERS -> [String] (51301.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: CLASS _ MODIFIERS -> [String] (51301.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: METHOD _ MODIFIERS -> [String] (51301.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: Markup # content -> String (45619.0) -
変換する文字列を返します。
変換する文字列を返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる事があります。
@see SM::SimpleMarkup#convert -
RDoc
:: Options # rdoc _ include -> [String] (45604.0) -
コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。
コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。
指定しなかった場合は ['.'] を返します。 -
RDoc
:: Text # strip _ newlines(text) -> String (45601.0) -
引数から先頭と末尾の改行を削除します。
引数から先頭と末尾の改行を削除します。
@param text 文字列を指定します。 -
RDoc
:: KNOWN _ CLASSES -> {String => String} (45319.0) -
Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"
ライブラリの内部で使用します。 -
Gem
:: Commands :: RdocCommand (45049.0) -
RDoc と ri のライブラリを生成するためのクラスです。
RDoc と ri のライブラリを生成するためのクラスです。 -
RDoc
:: Generator :: JsonIndex . new(parent _ generator , options) -> RDoc :: Generator :: JsonIndex (37306.0) -
RDoc::Generator::JsonIndex オブジェクトを初期化します。
RDoc::Generator::JsonIndex オブジェクトを初期化します。
@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します。
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。
@... -
Gem
:: Specification # rdoc _ options=(options) (36970.0) -
API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。
API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。
@param options API ドキュメントを生成するときに rdoc コマンドに与えるオプションを指定します。 -
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 :: Section # parent -> RDoc :: Context (36952.0) -
自身が所属する RDoc::Context オブジェクトを返します。
自身が所属する RDoc::Context オブジェクトを返します。 -
RDoc
:: Markup :: ToRdoc . new(markup = nil) -> RDoc :: Markup :: ToRdoc (36922.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Context # current _ section -> RDoc :: Context :: Section (36904.0) -
現在の section を返します。
現在の section を返します。 -
Gem
:: DocManager # run _ rdoc(*args) (36688.0) -
与えられた引数を使用して RDoc を実行します。
与えられた引数を使用して RDoc を実行します。
@param args RDoc に与える引数を指定します。
@raise Gem::FilePermissionError RDoc でドキュメント生成中にファイルにアクセス出来なかった場合に発生します。 -
RDoc
:: Context # add _ constant(const) -> () (36667.0) -
引数で指定した RDoc::Constant オブジェクトを追加します。
引数で指定した RDoc::Constant オブジェクトを追加します。
@param const RDoc::Constant オブジェクトを指定します。 -
Gem
:: DocManager # generate _ rdoc (36652.0) -
自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。
自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。 -
Gem
:: DocManager # install _ rdoc (36652.0) -
RDoc を生成してインストールします。
RDoc を生成してインストールします。 -
Gem
:: DocManager # rdoc _ installed? -> bool (36652.0) -
RDoc がインストール済みの場合は、真を返します。 そうでない場合は偽を返します。
RDoc がインストール済みの場合は、真を返します。
そうでない場合は偽を返します。 -
Gem
:: Specification # rdoc _ options -> [String] (36652.0) -
API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。
API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。 -
RDoc
:: Context # ongoing _ visibility=(vis) (36601.0) -
Change the default visibility for new methods
Change the default visibility for new methods -
RDoc
:: Context # set _ current _ section(title , comment) -> () (36601.0) -
Handle sections
Handle sections -
RDoc
:: Context :: Section # set _ comment(comment) -> () (36601.0) -
自身にコメントを設定します。
自身にコメントを設定します。
@param comment 文字列を指定します。
comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。
# ---------------------
# :section: The title
# The body
# --------------------- -
RDoc
:: Markdown :: DEFAULT _ EXTENSIONS -> [Symbol] (36601.0) -
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。 -
RDoc
:: Markdown :: EXTENSIONS -> [Symbol] (36601.0) -
サポートする拡張の一覧を Symbol の配列で返します。
サポートする拡張の一覧を Symbol の配列で返します。 -
rdoc
/ generator (36547.0) -
RDoc が解析したソースコードを RDoc::CodeObject のツリーから その他の形式に出力するためのサブライブラリです。
RDoc が解析したソースコードを RDoc::CodeObject のツリーから
その他の形式に出力するためのサブライブラリです。
RDoc には HTML 向けのジェネレータの
RDoc::Generator::Darkfish と ri 向けのジェネレータの
RDoc::Generator::RI が付属しています。
=== ジェネレータの登録
RDoc::RDoc.add_generator を呼び出す事でジェネレータの登録が行えます。
class My::Awesome::Generator
RDoc::RDoc.add_generator self
end
... -
RDoc
:: RDoc # document(argv) -> nil (36355.0) -
argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。
argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ
レクトリに出力します。
@param argv コマンドラインで rdoc コマンドに指定するのと同じ引数を文字
列の配列で指定します。
@raise RDoc::Error ドキュメントの処理中にエラーがあった場合に発生します。
指定できるオプションについては、lib:rdoc#usage を参照してくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の
doc 以下に出力します。 -
RDoc
:: Generator :: JsonIndex # generate -> () (36349.0) -
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出 力します。
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。 -
RDoc
:: Options # write _ options -> object (36349.0) -
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式 で保存します。
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式
で保存します。 -
Gem
:: InstallUpdateOptions # install _ update _ defaults _ str -> String (36319.0) -
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
デフォルトのオプションは以下の通りです。
--rdoc --no-force --no-test --wrappers -
RDoc
:: RDoc . add _ generator(klass) -> klass (36319.0) -
引数 klass で指定したクラスをジェネレータとして登録します。
引数 klass で指定したクラスをジェネレータとして登録します。
@param klass 登録するクラスを指定します。
@see c:RDoc::Options#custom_options -
RDoc
:: Context :: Section # comment -> String | nil (36301.0) -
section のコメントを返します。
section のコメントを返します。 -
RDoc
:: Generator :: Darkfish # generate -> () (36301.0) -
解析した情報を HTML ファイルや検索用のインデックスに出力します。
解析した情報を HTML ファイルや検索用のインデックスに出力します。 -
RDoc
:: Generator :: Darkfish :: GENERATOR _ DIR -> String (36301.0) -
このファイルの親ディレクトリへのパスを表す文字列です。
このファイルの親ディレクトリへのパスを表す文字列です。
テンプレートなどのリソースを検索するのに内部で使用します。 -
RDoc
:: Generator :: RI # generate -> () (36301.0) -
解析した情報を ri コマンドから読めるようにファイルに出力します。
解析した情報を ri コマンドから読めるようにファイルに出力します。 -
rdoc
/ markdown (36265.0) -
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための サブライブラリです。
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
サブライブラリです。
詳しくは以下を参照してください。
* https://daringfireball.net/projects/markdown/syntax
Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考に プロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。
=== 拡張
以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効にな... -
rdoc
/ context (36097.0) -
RDoc::Context と RDoc::Context::Section を定義するサブライ ブラリです。
RDoc::Context と RDoc::Context::Section を定義するサブライ
ブラリです。 -
rdoc
/ markup / to _ ansi (36085.0) -
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ ブラリです。
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ
ブラリです。
require 'rdoc/markup/to_ansi'
h = RDoc::Markup::ToAnsi.new
puts h.convert(input_string)
変換した結果は文字列で取得できます。 -
rubygems
/ commands / install _ command (36073.0) -
Gem パッケージをローカルリポジトリにインストールするためのライブラリです。
Gem パッケージをローカルリポジトリにインストールするためのライブラリです。
Usage: gem install GEMNAME [GEMNAME ...] [options] -- --build-flags [options]
Options:
--platform PLATFORM 指定されたプラットフォームの Gem パッケージをインストールします
-v, --version VERSION 指定されたバージョンの Gem パッケージをインストールします
Install/Update Op... -
rdoc
/ anon _ class (36049.0) -
RDoc::AnonClass を定義するサブライブラリです。
RDoc::AnonClass を定義するサブライブラリです。 -
rdoc
/ any _ method (36049.0) -
RDoc::AnyMethod を定義するサブライブラリです。
RDoc::AnyMethod を定義するサブライブラリです。 -
rdoc
/ constant (36049.0) -
RDoc::Constant を定義するサブライブラリです。
RDoc::Constant を定義するサブライブラリです。 -
rdoc
/ include (36049.0) -
RDoc::Include を定義するサブライブラリです。
RDoc::Include を定義するサブライブラリです。 -
rdoc
/ normal _ class (36049.0) -
RDoc::NormalClass を定義するサブライブラリです。
RDoc::NormalClass を定義するサブライブラリです。 -
rdoc
/ normal _ module (36049.0) -
RDoc::NormalModule を定義するサブライブラリです。
RDoc::NormalModule を定義するサブライブラリです。 -
rdoc
/ options (36049.0) -
rdoc コマンドのオプションを解析するためのサブライブラリです。
rdoc コマンドのオプションを解析するためのサブライブラリです。 -
rdoc
/ single _ class (36049.0) -
RDoc::SingleClass を定義するサブライブラリです。
RDoc::SingleClass を定義するサブライブラリです。 -
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
/ parser / changelog (36019.0) -
ChangeLog ファイルを解析するためのサブライブラリです。
ChangeLog ファイルを解析するためのサブライブラリです。
ChangeLog ファイルを解析して、RDoc::Markup::Document オブジェクト
に変換します。出力される HTML はサイドバーに日ごとに分けられます。
このサブライブラリは主に MRI の ChangeLog を解析するために使われますが、
GNU style の ChangeLog(http://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html
参照)であれば解析できます。 -
rubygems
/ commands / server _ command (36019.0) -
ローカルにインストールされている Gem パッケージとそのドキュメントを HTTP サーバに 載せて公開するためのライブラリです。
ローカルにインストールされている Gem パッケージとそのドキュメントを HTTP サーバに
載せて公開するためのライブラリです。
Usage: gem server [options]
Options:
-p, --port=PORT port to listen on
-d, --dir=GEMDIR directory from which to serve gems
--[no-]daemon run as a daemon
... -
rdoc
/ generator / darkfish (36001.0) -
HTML を生成するためのサブライブラリです。
HTML を生成するためのサブライブラリです。 -
rdoc
/ generator / markup (36001.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
rdoc
/ generator / ri (36001.0) -
ri のためのファイルを生成するためのサブライブラリです。
ri のためのファイルを生成するためのサブライブラリです。 -
rdoc
/ known _ classes (36001.0) -
Ruby の組み込みクラスに関する定数を定義するサブライブラリです。
Ruby の組み込みクラスに関する定数を定義するサブライブラリです。 -
rdoc
/ markdown / entities (36001.0) -
HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。
HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。 -
rdoc
/ parser / markdown (36001.0) -
Markdown 形式で記述されたファイルを解析するためのサブライブラリです。
Markdown 形式で記述されたファイルを解析するためのサブライブラリです。 -
rdoc
/ token _ stream (36001.0) -
トークンを管理するためのサブライブラリです。
トークンを管理するためのサブライブラリです。 -
RDoc
:: TopLevel # find _ local _ symbol(name) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule | RDoc :: AnyMethod | RDoc :: Alias | RDoc :: Attr | RDoc :: Constant (29422.0) -
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。 -
RDoc
:: TopLevel . all _ classes _ and _ modules -> [RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule] (28258.0) -
RDoc が収集したクラス、モジュールを配列で返します。
RDoc が収集したクラス、モジュールを配列で返します。 -
RDoc
:: TopLevel . find _ class _ named(name) -> RDoc :: NormalClass | RDoc :: SingleClass | nil (27955.0) -
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ からなかった場合は nil を返します。
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ
からなかった場合は nil を返します。
@param name クラス名を文字列で指定します。 -
RDoc
:: Context # includes -> [RDoc :: Include] (27952.0) -
追加された RDoc::Include の配列を返します。
追加された RDoc::Include の配列を返します。 -
RDoc
:: Markup # attribute _ manager -> RDoc :: AttributeManager (27952.0) -
自身の RDoc::AttributeManager オブジェクトを返します。
自身の RDoc::AttributeManager オブジェクトを返します。 -
Rake
:: RDocTask . new(name = :rdoc) {|pkg| . . . } -> Rake :: RDocTask (27952.0) -
自身を初期化して RDoc タスクを定義します。
自身を初期化して RDoc タスクを定義します。
ブロックが与えられた場合は、自身をブロックパラメータとして
ブロックを評価します。
@param name タスクの名前を指定します。 -
RDoc
:: CodeObject # section -> RDoc :: Context :: Section (27904.0) -
所属している section を返します。
所属している section を返します。 -
RDoc
:: Generator :: Darkfish # initialize(store , options) -> RDoc :: Generator :: Darkfish (27688.0) -
RDoc::Generator::Darkfish オブジェクトを初期化します。
RDoc::Generator::Darkfish オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。 -
RDoc
:: Generator :: RI # initialize(store , options) -> RDoc :: Generator :: RI (27688.0) -
RDoc::Generator::RI オブジェクトを初期化します。
RDoc::Generator::RI オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。 -
RDoc
:: Parser :: Simple # scan -> RDoc :: TopLevel (27670.0) -
自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し ます。
自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し
ます。
@return RDoc::TopLevel オブジェクトを返します。 -
RDoc
:: Context # add _ include(an _ include) -> () (27667.0) -
引数で指定した RDoc::Include オブジェクトを追加します。
引数で指定した RDoc::Include オブジェクトを追加します。
@param an_include RDoc::Include オブジェクトを指定します。 -
Rake
:: RDocTask # options=(options) (27667.0) -
rdoc コマンドに渡すオプションのリストをセットします。
rdoc コマンドに渡すオプションのリストをセットします。
@param options rdoc コマンドに渡されるオプションを指定します。 -
RDoc
:: Parser :: C . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: C (27658.0) -
自身を初期化します。
自身を初期化します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
RDoc
:: Parser :: Ruby . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: Ruby (27658.0) -
自身を初期化します。
自身を初期化します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
RDoc
:: Parser :: Simple . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: Simple (27658.0) -
自身を初期化します。
自身を初期化します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body 内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
Gem
:: Specification # extra _ rdoc _ files -> [String] (27652.0) -
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。 -
RDoc
:: Context # find _ module _ named(name) -> RDoc :: NormalModule | nil (27652.0) -
追加された RDoc::NormalModule から引数で指定した名前のモジュール を検索します。見つからなかった場合は nil を返します。
追加された RDoc::NormalModule から引数で指定した名前のモジュール
を検索します。見つからなかった場合は nil を返します。
@param name モジュールの名前を文字列で指定します。 -
RDoc
:: Context # sections -> RDoc :: Context :: Section (27652.0) -
追加された RDoc::Context::Section の配列を返します。
追加された RDoc::Context::Section の配列を返します。 -
RDoc
:: Context # unmatched _ alias _ lists -> {String => RDoc :: Alias} (27652.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。
メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。 -
RDoc
:: TopLevel # find _ module _ named(name) -> RDoc :: NormalModule (27652.0) -
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。 見つからなかった場合は nil を返します。
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。
見つからなかった場合は nil を返します。
@param name モジュール名を文字列で指定します。 -
RDoc
:: Markdown :: HTML _ ENTITIES -> {String => [Integer]} (27649.0) -
HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。
HTML の実体参照のマッピングを表す Hash オブジェクトです。
RDoc::Markdown で使用します。 -
RDoc
:: Context :: Section . new(parent , title , comment) -> RDoc :: Context :: Section (27622.0) -
自身を初期化します。
自身を初期化します。
@param parent RDoc::Context オブジェクトを指定します。
@param title section のタイトルを文字列で指定します。
@param comment section のコメントを文字列で指定します。
また、section のシーケンス番号を新しく作成します。 -
RDoc
:: Markup . new(attribute _ manager = nil) -> RDoc :: Markup (27622.0) -
自身を初期化します。
自身を初期化します。
@param attribute_manager Rdoc::AttributeManager オブジェクトを指
定します。 -
RDoc
:: Markup :: Formatter . new(markup = nil) -> RDoc :: Markup :: Formatter (27622.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Markup :: ToAnsi . new(markup = nil) -> RDoc :: Markup :: ToAnsi (27622.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Markup :: ToBs . new(markup = nil) -> RDoc :: Markup :: ToBs (27622.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Markup :: ToHtmlCrossref . new(path , context , show _ hash) -> RDoc :: Markup :: ToHtmlCrossref (27622.0) -
自身を初期化します。
自身を初期化します。
@param path 生成するファイルのパスを文字列で指定します。
@param context RDoc::Context オブジェクトかそのサブクラスのオブジェ
クトを指定します。
@param show_hash true を指定した場合、メソッド名のリンクに # を表示しま
す。false の場合は表示しません。
@raise ArgumentError path に nil を指定した場合に発生します。 -
RDoc
:: Parser :: C # scan -> RDoc :: TopLevel (27622.0) -
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析します。
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析します。
@return RDoc::TopLevel オブジェクトを返します。