ライブラリ
-
rake
/ rdoctask (2) - rdoc (1)
-
rdoc
/ attr (1) -
rdoc
/ code _ object (1) -
rdoc
/ context (10) -
rdoc
/ generator (1) -
rdoc
/ generator / darkfish (5) -
rdoc
/ generator / json _ index (4) -
rdoc
/ generator / markup (1) -
rdoc
/ generator / ri (4) -
rdoc
/ markup (4) -
rdoc
/ markup / formatter (4) -
rdoc
/ markup / to _ html _ crossref (1) -
rdoc
/ parser (2) -
rdoc
/ parser / c (1) -
rdoc
/ parser / ruby (1) -
rdoc
/ parser / simple (2) -
rdoc
/ rdoc (1) -
rdoc
/ stats (11) -
rdoc
/ top _ level (5) -
rubygems
/ doc _ manager (2) -
rubygems
/ specification (7)
クラス
-
Gem
:: DocManager (2) -
Gem
:: Specification (7) -
RDoc
:: CodeObject (1) -
RDoc
:: Context (10) -
RDoc
:: Generator :: Darkfish (4) -
RDoc
:: Generator :: JsonIndex (3) -
RDoc
:: Generator :: RI (3) -
RDoc
:: Markup (4) -
RDoc
:: Markup :: Formatter (3) -
RDoc
:: Markup :: ToHtmlCrossref (1) -
RDoc
:: Options (16) -
RDoc
:: Parser (2) -
RDoc
:: Parser :: C (1) -
RDoc
:: Parser :: Ruby (1) -
RDoc
:: Parser :: Simple (2) -
RDoc
:: RDoc (1) -
RDoc
:: Stats (10) -
RDoc
:: TopLevel (5) -
Rake
:: RDocTask (2)
モジュール
-
Gem
:: InstallUpdateOptions (1) - RDoc (1)
キーワード
-
ATTR
_ MODIFIERS (1) - Attr (1)
- DEPRECATED (1)
- DESCRIPTION (1)
- Darkfish (1)
- Formatter (1)
-
GENERATOR
_ DIR (1) - Generator (1)
- JsonIndex (1)
- Markup (1)
-
NEWS for Ruby 2
. 0 . 0 (1) -
NEWS for Ruby 2
. 4 . 0 (1) -
NEWS for Ruby 2
. 5 . 0 (1) - RI (1)
-
SEARCH
_ INDEX _ FILE (1) - Stats (1)
- VERSION (1)
- VISIBILITIES (1)
-
add
_ attribute (1) -
add
_ generator (1) -
add
_ special (1) -
add
_ tag (1) -
attribute
_ manager (1) - attributes (1)
- convert (2)
-
defined
_ in? (1) -
each
_ attribute (1) -
extra
_ rdoc _ files (1) -
extra
_ rdoc _ files= (1) -
file
_ relative _ name (1) -
file
_ relative _ name= (1) -
file
_ stat (1) -
file
_ stat= (1) -
find
_ enclosing _ module _ named (1) -
find
_ local _ symbol (1) -
force
_ update (1) - formatter (1)
- formatter= (1)
- generate (3)
-
generate
_ rdoc (1) - generator (1)
- generator= (1)
-
has
_ rdoc (1) -
has
_ rdoc= (1) -
has
_ rdoc? (1) -
image
_ format (1) - initialize (2)
-
install
_ update _ defaults _ str (1) - new (8)
-
num
_ classes (1) -
num
_ classes= (1) -
num
_ files (1) -
num
_ files= (1) -
num
_ methods (1) -
num
_ methods= (1) -
num
_ modules (1) -
num
_ modules= (1) -
page
_ dir (1) -
parse
_ files _ matching (1) -
parser
_ for (1) - print (1)
-
rdoc
/ attr (1) -
rdoc
/ generator (1) -
rdoc
/ generator / darkfish (1) -
rdoc
/ generator / json _ index (1) -
rdoc
/ generator / markup (1) -
rdoc
/ generator / ri (1) -
rdoc
/ markdown (1) -
rdoc
/ markup / formatter (1) -
rdoc
/ stats (1) -
record
_ location (1) -
remove
_ private _ comments (1) - root (1)
-
ruby 1
. 8 . 2 feature (1) -
ruby 1
. 8 . 4 feature (1) -
sanitize
_ path (1) -
static
_ path (1) -
static
_ path= (1) - template (2)
- template= (1)
-
template
_ dir (1) -
template
_ dir= (1) -
unmatched
_ alias _ lists (1) -
unmatched
_ alias _ lists= (1) -
update
_ ri _ cache (1) - visibility (2)
- 正規表現 (1)
検索結果
先頭5件
-
rdoc (115123.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。
このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ... -
RDoc
:: ATTR _ MODIFIERS -> [String] (69301.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: Options # static _ path -> [String] (45601.0) -
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し ます。
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。 -
RDoc
:: Options # static _ path=(vals) (45601.0) -
コマンドライン引数の --copy-files オプションと同様の指定を行います。
コマンドライン引数の --copy-files オプションと同様の指定を行います。
@param vals パスを文字列の配列で指定します。 -
Gem
:: DocManager # generate _ rdoc (36652.0) -
自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。
自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。 -
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
:: Generator :: JsonIndex # generate -> () (36349.0) -
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出 力します。
解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。 -
RDoc
:: RDoc . add _ generator(klass) -> klass (36319.0) -
引数 klass で指定したクラスをジェネレータとして登録します。
引数 klass で指定したクラスをジェネレータとして登録します。
@param klass 登録するクラスを指定します。
@see c:RDoc::Options#custom_options -
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
/ attr (36049.0) -
RDoc::Attr を定義するサブライブラリです。
RDoc::Attr を定義するサブライブラリです。 -
rdoc
/ markup / formatter (36049.0) -
RDoc 形式のドキュメントを整形するためのサブライブラリです。
RDoc 形式のドキュメントを整形するためのサブライブラリです。 -
rdoc
/ stats (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
/ generator / darkfish (36001.0) -
HTML を生成するためのサブライブラリです。
HTML を生成するためのサブライブラリです。 -
rdoc
/ generator / markup (36001.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
rdoc
/ generator / ri (36001.0) -
ri のためのファイルを生成するためのサブライブラリです。
ri のためのファイルを生成するためのサブライブラリです。 -
RDoc
:: Context # attributes -> [RDoc :: Attr] (27952.0) -
追加された RDoc::Attr の配列を返します。
追加された RDoc::Attr の配列を返します。 -
RDoc
:: Context # each _ attribute {|a| . . . } -> [RDoc :: Attr] (27952.0) -
追加された RDoc::Attr に対してブロックを評価します。
追加された RDoc::Attr に対してブロックを評価します。 -
RDoc
:: Markup # attribute _ manager -> RDoc :: AttributeManager (27952.0) -
自身の RDoc::AttributeManager オブジェクトを返します。
自身の RDoc::AttributeManager オブジェクトを返します。 -
Gem
:: Specification # extra _ rdoc _ files=(paths) (27670.0) -
RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。
RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。
@param paths RDoc でドキュメントを作成する際に使用する特別なファイルのリストを指定します。 -
RDoc
:: Context # add _ attribute(an _ attribute) -> () (27667.0) -
引数で指定した RDoc::Attr オブジェクトを追加します。
引数で指定した RDoc::Attr オブジェクトを追加します。
@param an_attribute RDoc::Attr オブジェクトを指定します。 -
RDoc
:: Context # unmatched _ alias _ lists -> {String => RDoc :: Alias} (27652.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。
メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。 -
RDoc
:: Options # generator -> Generator (27601.0) -
コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。
コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。
指定しなかった場合は、HTML に対応する Generator を返します。 -
RDoc
:: Options # sanitize _ path(path) (27601.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: TopLevel # file _ stat -> File :: Stat (27601.0) -
自身が管理するファイルに関する File::Stat オブジェクトを返します。
自身が管理するファイルに関する File::Stat オブジェクトを返します。 -
Rake
:: RDocTask # template=(template) (27601.0) -
使用するテンプレートをセットします。
使用するテンプレートをセットします。
@param template 使用するテンプレートを指定します。 -
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 # rdoc _ options=(options) (27370.0) -
API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。
API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。
@param options API ドキュメントを生成するときに rdoc コマンドに与えるオプションを指定します。 -
RDoc
:: Context # unmatched _ alias _ lists=(val) (27367.0) -
メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を設定します。
メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を設定します。
@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。 -
Gem
:: Specification # extra _ rdoc _ files -> [String] (27352.0) -
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。 -
Gem
:: Specification # has _ rdoc=(flag) (27352.0) -
RDoc を生成するかどうかをセットします。デフォルトは偽です。
RDoc を生成するかどうかをセットします。デフォルトは偽です。 -
Gem
:: Specification # rdoc _ options -> [String] (27352.0) -
API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。
API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。 -
Rake
:: RDocTask # template -> String (27349.0) -
使用するテンプレートを返します。 デフォルトは RDoc のデフォルトです。
使用するテンプレートを返します。
デフォルトは RDoc のデフォルトです。 -
RDoc
:: Parser # parse _ files _ matching(regexp) -> () (27337.0) -
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、
自身を登録します。
@param regexp 正規表現を指定します。
新しいパーサを作成する時に使用します。
例:
class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end -
Gem
:: InstallUpdateOptions # install _ update _ defaults _ str -> String (27319.0) -
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。
デフォルトのオプションは以下の通りです。
--rdoc --no-force --no-test --wrappers -
RDoc
:: CodeObject # metadata -> Hash (27301.0) -
自身が持つメタデータ(他から任意の値を設定してもよい)を返します。
自身が持つメタデータ(他から任意の値を設定してもよい)を返します。 -
RDoc
:: Context # record _ location(toplevel) (27301.0) -
Record the file that we happen to find it in
Record the file that we happen to find it in -
RDoc
:: Options # force _ update -> bool (27301.0) -
コマンドライン引数の --force_update を指定していた場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --force_update を指定していた場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # formatter -> nil (27301.0) -
使用されていません。常に nil を返します。
使用されていません。常に nil を返します。 -
RDoc
:: Options # formatter=(val) (27301.0) -
使用されていません。
使用されていません。 -
RDoc
:: Options # generator=(val) (27301.0) -
コマンドライン引数の --fmt オプションと同様の指定を行います。
コマンドライン引数の --fmt オプションと同様の指定を行います。
@param val 設定する Generator を指定します。 -
RDoc
:: Options # image _ format -> String (27301.0) -
コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。
コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。
指定しなかった場合は 'png' を返します。 -
RDoc
:: Options # template -> String (27301.0) -
コマンドライン引数の --template オプションで指定した名前を文字列の配列 で返します。
コマンドライン引数の --template オプションで指定した名前を文字列の配列
で返します。
指定しなかった場合は 'html' を返します。 -
RDoc
:: Options # template _ dir -> String | nil (27301.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを返します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。
オプションの解析前は nil を返します。 -
RDoc
:: Options # template _ dir=(val) (27301.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを設定します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。
@param val パスを文字列で指定します。 -
RDoc
:: Options :: DEPRECATED -> {String -> String} (27301.0) -
非推奨のオプションの一覧を返します。
非推奨のオプションの一覧を返します。 -
RDoc
:: Parser :: Simple # remove _ private _ comments(comment) -> String (27301.0) -
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返 します。
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。
@param comment 対象の文字列を指定します。
@return コメントが削除された文字列を返します。 -
RDoc
:: TopLevel # file _ relative _ name -> String (27301.0) -
自身が管理するファイルに関する相対パスを文字列で返します。
自身が管理するファイルに関する相対パスを文字列で返します。 -
RDoc
:: TopLevel # file _ relative _ name=(val) (27301.0) -
自身が管理するファイルに関する相対パスを文字列で設定します。
自身が管理するファイルに関する相対パスを文字列で設定します。
@param val パスを文字列で指定します。 -
RDoc
:: TopLevel # file _ stat=(val) (27301.0) -
自身が管理するファイルに関する File::Stat オブジェクトを設定しま す。
自身が管理するファイルに関する File::Stat オブジェクトを設定しま
す。
@param val File::Stat オブジェクトを指定します。 -
RDoc
:: Generator (27097.0) -
RDoc が解析したソースコードを RDoc::CodeObject のツリーから その他の形式に出力するためのクラスです。
RDoc が解析したソースコードを RDoc::CodeObject のツリーから
その他の形式に出力するためのクラスです。 -
RDoc
:: Markup :: Formatter (27067.0) -
RDoc 形式のドキュメントを整形するための基本クラスです。
RDoc 形式のドキュメントを整形するための基本クラスです。
実際にドキュメントを整形するには、RDoc::Markup::ToHtml のような、
継承したクラスで convert メソッドを実行してください。 -
RDoc
:: Stats (27049.0) -
RDoc のステータスを管理するクラスです。
RDoc のステータスを管理するクラスです。 -
RDoc
:: Attr (27001.0) -
属性を表現するクラスです。
属性を表現するクラスです。
ライブラリの内部で使用します。 -
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
:: Generator :: Darkfish # initialize(store , options) -> RDoc :: Generator :: Darkfish (18688.0) -
RDoc::Generator::Darkfish オブジェクトを初期化します。
RDoc::Generator::Darkfish オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。 -
RDoc
:: Generator :: RI # initialize(store , options) -> RDoc :: Generator :: RI (18688.0) -
RDoc::Generator::RI オブジェクトを初期化します。
RDoc::Generator::RI オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。 -
RDoc
:: Markup :: Formatter . new(markup = nil) -> RDoc :: Markup :: Formatter (18622.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Stats . new -> RDoc :: Stats (18604.0) -
自身を初期化します。
自身を初期化します。 -
Gem
:: DocManager . update _ ri _ cache (18349.0) -
RDoc 2 がインストールされている場合は RI のキャッシュを更新します。 そうでない場合は何もしません。
RDoc 2 がインストールされている場合は RI のキャッシュを更新します。
そうでない場合は何もしません。 -
rdoc
/ markdown (18283.0) -
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための サブライブラリです。
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
サブライブラリです。
詳しくは以下を参照してください。
* https://daringfireball.net/projects/markdown/syntax
Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考に プロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。
=== 拡張
以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効にな... -
RDoc
:: Markup :: Formatter # add _ tag(name , start , stop) -> () (18055.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
:: Generator :: Darkfish (18001.0) -
HTML を生成するためのクラスです。
HTML を生成するためのクラスです。 -
RDoc
:: Generator :: Darkfish :: VERSION -> & # 39;3& # 39; (18001.0) -
darkfish のバージョンです。
darkfish のバージョンです。 -
RDoc
:: Generator :: JsonIndex (18001.0) -
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ クスを生成するクラスです。
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するクラスです。 -
RDoc
:: Generator :: JsonIndex :: SEARCH _ INDEX _ FILE -> String (18001.0) -
検索インデックスのパスを表す文字列です。
検索インデックスのパスを表す文字列です。 -
RDoc
:: Generator :: Markup (18001.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: Generator :: RI (18001.0) -
ri のためのファイルを生成するためのクラスです。
ri のためのファイルを生成するためのクラスです。 -
RDoc
:: Generator :: RI :: DESCRIPTION -> String (18001.0) -
このジェネレータの説明を表す文字列です。
このジェネレータの説明を表す文字列です。 -
RDoc
:: Markup :: Formatter # convert(content) -> () (18001.0) -
content で指定された文字列を変換します。
content で指定された文字列を変換します。
@param content 変換する文字列を指定します。 -
RDoc
:: Stats # num _ classes -> Integer (18001.0) -
解析したクラスの数を返します。
解析したクラスの数を返します。 -
RDoc
:: Stats # num _ classes=(val) (18001.0) -
解析したクラスの数を指定します。
解析したクラスの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ files -> Integer (18001.0) -
解析したファイルの数を返します。
解析したファイルの数を返します。 -
RDoc
:: Stats # num _ files=(val) (18001.0) -
解析したファイルの数を指定します。
解析したファイルの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ methods -> Integer (18001.0) -
解析したメソッドの数を返します。
解析したメソッドの数を返します。 -
RDoc
:: Stats # num _ methods=(val) (18001.0) -
解析したメソッドの数を指定します。
解析したメソッドの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # num _ modules -> Integer (18001.0) -
解析したモジュールの数を返します。
解析したモジュールの数を返します。 -
RDoc
:: Stats # num _ modules=(val) (18001.0) -
解析したモジュールの数を指定します。
解析したモジュールの数を指定します。
@param val 数値を指定します。 -
RDoc
:: Stats # print -> () (18001.0) -
自身の持つ情報を標準出力に表示します。
自身の持つ情報を標準出力に表示します。 -
RDoc
:: TopLevel # find _ local _ symbol(name) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule | RDoc :: AnyMethod | RDoc :: Alias | RDoc :: Attr | RDoc :: Constant (11422.0) -
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。 -
RDoc
:: Parser . parser _ for(top _ level , file _ name , body , options , stats) -> RDoc :: Parser (9706.0) -
file_name を解析できるパーサのインスタンスを返します。 見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。
file_name を解析できるパーサのインスタンスを返します。
見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
RDoc
:: Parser :: C . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: C (9658.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 (9658.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 (9658.0) -
自身を初期化します。
自身を初期化します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body 内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
RDoc
:: Markup . new(attribute _ manager = nil) -> RDoc :: Markup (9622.0) -
自身を初期化します。
自身を初期化します。
@param attribute_manager Rdoc::AttributeManager オブジェクトを指
定します。 -
RDoc
:: Markup :: ToHtmlCrossref . new(path , context , show _ hash) -> RDoc :: Markup :: ToHtmlCrossref (9622.0) -
自身を初期化します。
自身を初期化します。
@param path 生成するファイルのパスを文字列で指定します。
@param context RDoc::Context オブジェクトかそのサブクラスのオブジェ
クトを指定します。
@param show_hash true を指定した場合、メソッド名のリンクに # を表示しま
す。false の場合は表示しません。
@raise ArgumentError path に nil を指定した場合に発生します。 -
RDoc
:: Context # find _ enclosing _ module _ named(name) -> RDoc :: NormalModule | nil (9352.0) -
find a module at a higher scope
find a module at a higher scope -
RDoc
:: Markup # add _ special(pattern , name) -> () (9337.0) -
pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま す。
pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま
す。
例えば WikiWord のような、SM::SimpleMarkup#add_word_pair、
SM::SimpleMarkup#add_html でフォーマットできないものに対して使用
します。
@param pattern 正規表現を指定します。
@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
例:
require 'rdoc/markup/simple_markup'
require '... -
RDoc
:: Context # visibility -> :public | :protected | :private (9301.0) -
自身の可視性を Symbol で返します。
自身の可視性を Symbol で返します。 -
RDoc
:: Context :: VISIBILITIES -> [:public , :protected , :private] (9301.0) -
メソッドの可視性を Symbol の配列で返します。
メソッドの可視性を Symbol の配列で返します。 -
RDoc
:: Markup # convert(str , formatter) -> object | "" (9301.0) -
str で指定された文字列を formatter に変換させます。
str で指定された文字列を formatter に変換させます。
@param str 変換する文字列を指定します。
@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。
変換結果は formatter によって文字列や配列を返します。 -
RDoc
:: Options # page _ dir -> Pathname | nil (9301.0) -
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し ます。
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し
ます。
指定されていない場合は nil を返します。 -
RDoc
:: Options # root -> Pathname (9301.0) -
コマンドライン引数の --root オプションで指定したディレクトリを返します。
コマンドライン引数の --root オプションで指定したディレクトリを返します。
指定されていない場合はカレントディレクトリを返します。 -
RDoc
:: Options # visibility -> :public | :protected | :private (9301.0) -
コマンドライン引数の --visibility で指定したオプションを Symbol で返します。
コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。 -
ruby 1
. 8 . 4 feature (9055.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
:: Context # defined _ in?(file) (9049.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 -
ruby 1
. 8 . 2 feature (9019.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]: 変更されたクラス/...