ライブラリ
- 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) - 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件
-
rdoc (115123.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。
このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ... -
RDoc
:: DOT _ DOC _ FILENAME -> " . document" (69349.0) -
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。 -
RDoc
:: ATTR _ MODIFIERS -> [String] (69301.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: CONSTANT _ MODIFIERS -> [String] (69301.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: METHOD _ MODIFIERS -> [String] (69301.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
rdoc
/ markup / to _ rdoc (54067.0) -
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための サブライブラリです。
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
サブライブラリです。
サブクラス(RDoc::Markup::ToAnsi など)を作成して使います。 -
rdoc
/ markdown / entities (54001.0) -
HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。
HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。 -
RDoc
:: VERSION -> String (51349.0) -
RDoc のバージョンを表す文字列を返します。
RDoc のバージョンを表す文字列を返します。 -
RDoc
:: CLASS _ MODIFIERS -> [String] (51301.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: GENERAL _ MODIFIERS -> [String] (51301.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
:: Markup :: ToRdoc (45049.0) -
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための クラスです。
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
クラスです。 -
Rake
:: RDocTask # template=(template) (37201.0) -
使用するテンプレートをセットします。
使用するテンプレートをセットします。
@param template 使用するテンプレートを指定します。 -
Gem
:: Specification # extra _ rdoc _ files -> [String] (36952.0) -
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。 -
RDoc
:: Context # attributes -> [RDoc :: Attr] (36952.0) -
追加された RDoc::Attr の配列を返します。
追加された RDoc::Attr の配列を返します。 -
RDoc
:: Context # each _ attribute {|a| . . . } -> [RDoc :: Attr] (36952.0) -
追加された RDoc::Attr に対してブロックを評価します。
追加された RDoc::Attr に対してブロックを評価します。 -
Gem
:: DocManager # setup _ rdoc (36670.0) -
RDoc を実行するための準備を行います。
RDoc を実行するための準備を行います。
@raise Gem::FilePermissionError RDoc を保存するディレクトリにアクセスする権限がない場合に発生します。 -
Gem
:: Specification # extra _ rdoc _ files=(paths) (36670.0) -
RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。
RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。
@param paths RDoc でドキュメントを作成する際に使用する特別なファイルのリストを指定します。 -
RDoc
:: Context # add _ attribute(an _ attribute) -> () (36667.0) -
引数で指定した RDoc::Attr オブジェクトを追加します。
引数で指定した RDoc::Attr オブジェクトを追加します。
@param an_attribute RDoc::Attr オブジェクトを指定します。 -
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 がインストール済みの場合は、真を返します。
そうでない場合は偽を返します。 -
Rake
:: RDocTask # rdoc _ files -> Rake :: FileList (36652.0) -
RDoc の生成に使用するファイルリストを返します。 デフォルトは空です。
RDoc の生成に使用するファイルリストを返します。
デフォルトは空です。 -
Rake
:: RDocTask # rdoc _ files=(filelist) (36652.0) -
RDoc の生成に使用するファイルリストをセットします。
RDoc の生成に使用するファイルリストをセットします。
@param filelist ファイルリストを指定します。 -
Rake
:: RDocTask # template -> String (36649.0) -
使用するテンプレートを返します。 デフォルトは RDoc のデフォルトです。
使用するテンプレートを返します。
デフォルトは RDoc のデフォルトです。 -
RDoc
:: Options # rdoc _ include -> [String] (36604.0) -
コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。
コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。
指定しなかった場合は ['.'] を返します。 -
Rake
:: RDocTask # rdoc _ dir -> String (36604.0) -
作成した HTML ファイルを保存するディレクトリ名を返します。 デフォルトは html です。
作成した HTML ファイルを保存するディレクトリ名を返します。
デフォルトは html です。 -
RDoc
:: CodeObject # metadata -> Hash (36601.0) -
自身が持つメタデータ(他から任意の値を設定してもよい)を返します。
自身が持つメタデータ(他から任意の値を設定してもよい)を返します。 -
RDoc
:: Context # set _ current _ section(title , comment) -> () (36601.0) -
Handle sections
Handle sections -
RDoc
:: Options # option _ parser -> OptionParser | nil (36601.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。
コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。 -
RDoc
:: Options # template -> String (36601.0) -
コマンドライン引数の --template オプションで指定した名前を文字列の配列 で返します。
コマンドライン引数の --template オプションで指定した名前を文字列の配列
で返します。
指定しなかった場合は 'html' を返します。 -
RDoc
:: Options # template _ dir -> String | nil (36601.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを返します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。
オプションの解析前は nil を返します。 -
RDoc
:: Options # template _ dir=(val) (36601.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを設定します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。
@param val パスを文字列で指定します。 -
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
:: Options # write _ options -> object (36349.0) -
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式 で保存します。
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式
で保存します。 -
RDoc
:: RDoc . add _ generator(klass) -> klass (36319.0) -
引数 klass で指定したクラスをジェネレータとして登録します。
引数 klass で指定したクラスをジェネレータとして登録します。
@param klass 登録するクラスを指定します。
@see c:RDoc::Options#custom_options -
Rake
:: RDocTask # rdoc _ dir=(dir) (36304.0) -
作成した HTML ファイルを保存するディレクトリ名をセットします。
作成した HTML ファイルを保存するディレクトリ名をセットします。 -
RDoc
:: Generator :: Darkfish :: GENERATOR _ DIR -> String (36301.0) -
このファイルの親ディレクトリへのパスを表す文字列です。
このファイルの親ディレクトリへのパスを表す文字列です。
テンプレートなどのリソースを検索するのに内部で使用します。 -
RDoc
:: Options # option _ parser=(val) (36301.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。
コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。
@param val OptionParser オブジェクトを指定します。 -
RDoc
:: Options # sanitize _ path(path) (36301.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: Options # static _ path -> [String] (36301.0) -
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し ます。
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。 -
RDoc
:: Options # static _ path=(vals) (36301.0) -
コマンドライン引数の --copy-files オプションと同様の指定を行います。
コマンドライン引数の --copy-files オプションと同様の指定を行います。
@param vals パスを文字列の配列で指定します。 -
RDoc
:: Options # title -> String | nil (36301.0) -
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。 -
RDoc
:: Options # title=(string) (36301.0) -
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文 字列に設定します。
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文
字列に設定します。
コマンドライン引数で既に --title オプションが指定されていた場合には、そ
ちらを優先します。
@param string 設定するタイトルを文字列で指定します。 -
rake
/ rdoctask (36235.0) -
ドキュメントを作成するためのタスクを定義します。
ドキュメントを作成するためのタスクを定義します。
以下のタスクを定義します。
: rdoc
RDoc を作成します。
: clobber_rdoc
生成された RDoc のファイルを削除します。
このタスクは clobber タスクにも追加されます。
: rerdoc
既に存在する RDoc が古くなくても RDoc を作成します。
例:
Rake::RDocTask.new do |rd|
rd.main = "README.rdoc"
rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
... -
rdoc
/ context (36097.0) -
RDoc::Context と RDoc::Context::Section を定義するサブライ ブラリです。
RDoc::Context と RDoc::Context::Section を定義するサブライ
ブラリです。 -
rdoc
/ parser / ruby _ tools (36097.0) -
RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー ドのパーサを記述するためのモジュールを定義するサブライブラリです。
RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー
ドのパーサを記述するためのモジュールを定義するサブライブラリです。 -
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)
変換した結果は文字列で取得できます。 -
rdoc
/ markup / to _ bs (36085.0) -
RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるサブライブラリです。
RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるサブライブラリです。
require 'rdoc/markup/to_bs'
h = RDoc::Markup::ToBs.new
puts h.convert(input_string)
変換した結果は文字列で取得できます。実際に効果を確認するためにはページャ
などで出力を確認します。
テキスト中の以下のマークアップ記法をエスケープシーケンスの \b と組み合
わせる事によって見た目を変更します。
* イタリック体(_word_): word にアンダーラインを付けて... -
rdoc
/ markup / to _ html (36085.0) -
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
require 'rdoc/markup/to_html'
h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)
変換した結果は文字列で取得できます。 -
rdoc
/ markup / to _ html _ crossref (36067.0) -
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。 -
rdoc
/ any _ method (36049.0) -
RDoc::AnyMethod を定義するサブライブラリです。
RDoc::AnyMethod を定義するサブライブラリです。 -
rdoc
/ attr (36049.0) -
RDoc::Attr を定義するサブライブラリです。
RDoc::Attr を定義するサブライブラリです。 -
rdoc
/ code _ object (36049.0) -
RDoc::CodeObject を定義するサブライブラリです。
RDoc::CodeObject を定義するサブライブラリです。 -
rdoc
/ constant (36049.0) -
RDoc::Constant を定義するサブライブラリです。
RDoc::Constant を定義するサブライブラリです。 -
rdoc
/ ghost _ method (36049.0) -
RDoc::GhostMethod を定義するサブライブラリです。
RDoc::GhostMethod を定義するサブライブラリです。 -
rdoc
/ markup / formatter (36049.0) -
RDoc 形式のドキュメントを整形するためのサブライブラリです。
RDoc 形式のドキュメントを整形するためのサブライブラリです。 -
rdoc
/ meta _ method (36049.0) -
RDoc::MetaMethod を定義するサブライブラリです。
RDoc::MetaMethod を定義するサブライブラリです。 -
rdoc
/ options (36049.0) -
rdoc コマンドのオプションを解析するためのサブライブラリです。
rdoc コマンドのオプションを解析するためのサブライブラリです。 -
rdoc
/ stats (36049.0) -
RDoc のステータスを管理するサブライブラリです。
RDoc のステータスを管理するサブライブラリです。 -
rdoc
/ top _ level (36049.0) -
RDoc::TopLevel を定義するサブライブラリです。
RDoc::TopLevel を定義するサブライブラリです。 -
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... -
Rake
:: RDocTask (36001.0) -
-
rdoc
/ code _ objects (36001.0) -
Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を 表現するためのサブライブラリです。
Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を
表現するためのサブライブラリです。 -
rdoc
/ generator / darkfish (36001.0) -
HTML を生成するためのサブライブラリです。
HTML を生成するためのサブライブラリです。 -
rdoc
/ generator / markup (36001.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
rdoc
/ generator / ri (36001.0) -
ri のためのファイルを生成するためのサブライブラリです。
ri のためのファイルを生成するためのサブライブラリです。 -
rdoc
/ parser / text (36001.0) -
プログラムを含まないテキストを解析するためのサブライブラリです。
プログラムを含まないテキストを解析するためのサブライブラリです。 -
rdoc
/ text (36001.0) -
コメントテキストを処理するためのサブライブラリです。
コメントテキストを処理するためのサブライブラリです。 -
rdoc
/ token _ stream (36001.0) -
トークンを管理するためのサブライブラリです。
トークンを管理するためのサブライブラリです。 -
RDoc
:: Generator :: Darkfish # initialize(store , options) -> RDoc :: Generator :: Darkfish (27988.0) -
RDoc::Generator::Darkfish オブジェクトを初期化します。
RDoc::Generator::Darkfish オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。 -
RDoc
:: Generator :: RI # initialize(store , options) -> RDoc :: Generator :: RI (27988.0) -
RDoc::Generator::RI オブジェクトを初期化します。
RDoc::Generator::RI オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。 -
RDoc
:: Context # constants -> [RDoc :: Constant] (27952.0) -
追加された RDoc::Constant の配列を返します。
追加された RDoc::Constant の配列を返します。 -
RDoc
:: Context # each _ constant {|c| . . . } -> [RDoc :: Constant] (27952.0) -
追加された RDoc::Constant に対してブロックを評価します。
追加された RDoc::Constant に対してブロックを評価します。 -
RDoc
:: Context # each _ method {|m| . . . } -> [RDoc :: AnyMethod] (27952.0) -
追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト) に対してブロックを評価します。
追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト)
に対してブロックを評価します。 -
RDoc
:: Context # method _ list -> [RDoc :: AnyMethod] (27952.0) -
追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列 を返します。
追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列
を返します。 -
RDoc
:: Context # sections -> RDoc :: Context :: Section (27952.0) -
追加された RDoc::Context::Section の配列を返します。
追加された RDoc::Context::Section の配列を返します。 -
RDoc
:: Context # toplevel -> RDoc :: TopLevel (27952.0) -
自身が所属する RDoc::TopLevel オブジェクトを返します。
自身が所属する RDoc::TopLevel オブジェクトを返します。 -
RDoc
:: Context :: Section # parent -> RDoc :: Context (27952.0) -
自身が所属する RDoc::Context オブジェクトを返します。
自身が所属する RDoc::Context オブジェクトを返します。 -
RDoc
:: Markup # attribute _ manager -> RDoc :: AttributeManager (27952.0) -
自身の RDoc::AttributeManager オブジェクトを返します。
自身の RDoc::AttributeManager オブジェクトを返します。 -
RDoc
:: Markup :: ToRdoc . new(markup = nil) -> RDoc :: Markup :: ToRdoc (27922.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: CodeObject # parent -> RDoc :: CodeObject (27904.0) -
自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。
自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。 -
RDoc
:: CodeObject # section -> RDoc :: Context :: Section (27904.0) -
所属している section を返します。
所属している section を返します。 -
RDoc
:: Options # extra _ accessor _ flags -> {String => String} (27901.0) -
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。
値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。 -
RDoc
:: Context # add _ method(a _ method) -> () (27667.0) -
引数で指定した RDoc::AnyMethod オブジェクトを追加します。
引数で指定した RDoc::AnyMethod オブジェクトを追加します。
@param a_method RDoc::AnyMethod オブジェクトかそのサブクラスのオ
ブジェクトを指定します。 -
Rake
:: RDocTask # options=(options) (27667.0) -
rdoc コマンドに渡すオプションのリストをセットします。
rdoc コマンドに渡すオプションのリストをセットします。
@param options rdoc コマンドに渡されるオプションを指定します。 -
RDoc
:: Markup :: Formatter # add _ tag(name , start , stop) -> () (27655.0) -
name で登録された規則で取得された文字列を start と stop で囲むように指 定します。
name で登録された規則で取得された文字列を start と stop で囲むように指
定します。
@param name RDoc::Markup::ToHtml などのフォーマッタに識別させる時
の名前を Symbol で指定します。
@param start 開始の記号を文字列で指定します。
@param stop 終了の記号を文字列で指定します。
例:
require 'rdoc/markup/to_html'
# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup:... -
RDoc
:: Context # unmatched _ alias _ lists -> {String => RDoc :: Alias} (27652.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。
メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。 -
Rake
:: RDocTask # title=(title) (27649.0) -
RDoc のタイトルをセットします。
RDoc のタイトルをセットします。
@param title タイトルを指定します。 -
RDoc
:: KNOWN _ CLASSES -> {String => String} (27619.0) -
Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"
ライブラリの内部で使用します。 -
RDoc
:: Context # current _ section -> RDoc :: Context :: Section (27604.0) -
現在の section を返します。
現在の section を返します。 -
RDoc
:: Options # generator -> Generator (27601.0) -
コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。
コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。
指定しなかった場合は、HTML に対応する Generator を返します。 -
RDoc
:: Text # strip _ hashes(text) -> String (27601.0) -
引数から各行の行頭の # を削除します。
引数から各行の行頭の # を削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # strip _ newlines(text) -> String (27601.0) -
引数から先頭と末尾の改行を削除します。
引数から先頭と末尾の改行を削除します。
@param text 文字列を指定します。 -
RDoc
:: Text # strip _ stars(text) -> String (27601.0) -
引数から /* 〜 */ 形式のコメントを削除します。
引数から /* 〜 */ 形式のコメントを削除します。
@param text 文字列を指定します。 -
RDoc
:: TopLevel # file _ stat -> File :: Stat (27601.0) -
自身が管理するファイルに関する File::Stat オブジェクトを返します。
自身が管理するファイルに関する File::Stat オブジェクトを返します。 -
RDoc
:: Context # set _ visibility _ for(methods , visibility , singleton = false) -> () (27433.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 _ to(array , thing) -> () (27427.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...