検索結果

rdoc (115123.0)

• 3.2

• ライブラリ

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。

このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ...

• RDoc
• RDoc::Error
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/generator
• rdoc/generator/darkfish
• rdoc/generator/json_index
• rdoc/generator/markup
• rdoc/generator/ri
• rdoc/ghost_method
• rdoc/include
• rdoc/known_classes
• rdoc/markdown
• ...

RDoc::DOT_DOC_FILENAME -> ".document" (69349.0)

• 3.2

• 定数

rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。

rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。

• RDoc

RDoc::ATTR_MODIFIERS -> [String] (69301.0)

• 3.2

• 定数

ライブラリの内部で使用します。

ライブラリの内部で使用します。

• RDoc

RDoc::CONSTANT_MODIFIERS -> [String] (69301.0)

• 3.2

• 定数

ライブラリの内部で使用します。

ライブラリの内部で使用します。

• RDoc

RDoc::METHOD_MODIFIERS -> [String] (69301.0)

• 3.2

• 定数

ライブラリの内部で使用します。

ライブラリの内部で使用します。

• RDoc

絞り込み条件を変える

rdoc/markup/to_rdoc (54067.0)

• 3.2

• ライブラリ

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための サブライブラリです。

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
サブライブラリです。

サブクラス(RDoc::Markup::ToAnsi など)を作成して使います。

• RDoc::Markup::ToRdoc

rdoc/markdown/entities (54001.0)

• 3.2

• ライブラリ

HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。

HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。

• HTML_ENTITIES

RDoc::VERSION -> String (51349.0)

• 3.2

• 定数

RDoc のバージョンを表す文字列を返します。

RDoc のバージョンを表す文字列を返します。

• RDoc

RDoc::CLASS_MODIFIERS -> [String] (51301.0)

• 3.2

• 定数

ライブラリの内部で使用します。

ライブラリの内部で使用します。

• RDoc

RDoc::GENERAL_MODIFIERS -> [String] (51301.0)

• 3.2

• 定数

ライブラリの内部で使用します。

ライブラリの内部で使用します。

• RDoc

絞り込み条件を変える

Gem::Specification#rdoc_options=(options) (45970.0)

• 3.2

• インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

@param options API ドキュメントを生成するときに rdoc コマンドに与えるオプションを指定します。

• Gem::Specification

Gem::Specification#rdoc_options -> [String] (45652.0)

• 3.2

• インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

• Gem::Specification

RDoc::Markup::ToRdoc (45049.0)

• 3.2

• クラス

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための クラスです。

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
クラスです。

Rake::RDocTask#template=(template) (37201.0)

• 3.2

• インスタンスメソッド

使用するテンプレートをセットします。

使用するテンプレートをセットします。

@param template 使用するテンプレートを指定します。

• Rake::RDocTask

Gem::Specification#extra_rdoc_files -> [String] (36952.0)

• 3.2

• インスタンスメソッド

RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。

RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。

• Gem::Specification

絞り込み条件を変える

RDoc::Context#attributes -> [RDoc::Attr] (36952.0)

• 3.2

• インスタンスメソッド

追加された RDoc::Attr の配列を返します。

追加された RDoc::Attr の配列を返します。

• RDoc::Attr
• RDoc::Context

RDoc::Context#each_attribute {|a| ... } -> [RDoc::Attr] (36952.0)

• 3.2

• インスタンスメソッド

追加された RDoc::Attr に対してブロックを評価します。

追加された RDoc::Attr に対してブロックを評価します。

• RDoc::Attr
• RDoc::Context

Gem::DocManager#setup_rdoc (36670.0)

• 3.2

• インスタンスメソッド

RDoc を実行するための準備を行います。

RDoc を実行するための準備を行います。

@raise Gem::FilePermissionError RDoc を保存するディレクトリにアクセスする権限がない場合に発生します。

• Gem::DocManager

Gem::Specification#extra_rdoc_files=(paths) (36670.0)

• 3.2

• インスタンスメソッド

RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。

RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。

@param paths RDoc でドキュメントを作成する際に使用する特別なファイルのリストを指定します。

• Gem::Specification

RDoc::Context#add_attribute(an_attribute) -> () (36667.0)

• 3.2

• インスタンスメソッド

引数で指定した RDoc::Attr オブジェクトを追加します。

引数で指定した RDoc::Attr オブジェクトを追加します。

@param an_attribute RDoc::Attr オブジェクトを指定します。

• RDoc::Attr
• RDoc::Context

絞り込み条件を変える

Gem::DocManager#generate_rdoc (36652.0)

• 3.2

• インスタンスメソッド

自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。

自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。

• Gem::DocManager
• Gem::Specification

Gem::DocManager#install_rdoc (36652.0)

• 3.2

• インスタンスメソッド

RDoc を生成してインストールします。

RDoc を生成してインストールします。

• Gem::DocManager

Gem::DocManager#rdoc_installed? -> bool (36652.0)

• 3.2

• インスタンスメソッド

RDoc がインストール済みの場合は、真を返します。 そうでない場合は偽を返します。

RDoc がインストール済みの場合は、真を返します。
そうでない場合は偽を返します。

• Gem::DocManager

Rake::RDocTask#rdoc_files -> Rake::FileList (36652.0)

• 3.2

• インスタンスメソッド

RDoc の生成に使用するファイルリストを返します。 デフォルトは空です。

RDoc の生成に使用するファイルリストを返します。
デフォルトは空です。

• Rake::RDocTask

Rake::RDocTask#rdoc_files=(filelist) (36652.0)

• 3.2

• インスタンスメソッド

RDoc の生成に使用するファイルリストをセットします。

RDoc の生成に使用するファイルリストをセットします。

@param filelist ファイルリストを指定します。

• Rake::RDocTask

絞り込み条件を変える

Rake::RDocTask#template -> String (36649.0)

• 3.2

• インスタンスメソッド

使用するテンプレートを返します。 デフォルトは RDoc のデフォルトです。

使用するテンプレートを返します。
デフォルトは RDoc のデフォルトです。

• Rake::RDocTask

RDoc::Options#rdoc_include -> [String] (36604.0)

• 3.2

• インスタンスメソッド

コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。

コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。

指定しなかった場合は ['.'] を返します。

• RDoc::Options

Rake::RDocTask#rdoc_dir -> String (36604.0)

• 3.2

• インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名を返します。 デフォルトは html です。

作成した HTML ファイルを保存するディレクトリ名を返します。
デフォルトは html です。

• Rake::RDocTask

RDoc::CodeObject#metadata -> Hash (36601.0)

• 3.2

• インスタンスメソッド

自身が持つメタデータ(他から任意の値を設定してもよい)を返します。

自身が持つメタデータ(他から任意の値を設定してもよい)を返します。

• RDoc::CodeObject

RDoc::Context#set_current_section(title, comment) -> () (36601.0)

• 3.2

• インスタンスメソッド

Handle sections

Handle sections

• RDoc::Context

絞り込み条件を変える

RDoc::Options#option_parser -> OptionParser | nil (36601.0)

• 3.2

• インスタンスメソッド

コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。

コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。

• OptionParser
• RDoc::Options

RDoc::Options#template -> String (36601.0)

• 3.2

• インスタンスメソッド

コマンドライン引数の --template オプションで指定した名前を文字列の配列 で返します。

コマンドライン引数の --template オプションで指定した名前を文字列の配列
で返します。

指定しなかった場合は 'html' を返します。

• RDoc::Options

RDoc::Options#template_dir -> String | nil (36601.0)

• 3.2

• インスタンスメソッド

コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを返します。

コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。

オプションの解析前は nil を返します。

• RDoc::Options

RDoc::Options#template_dir=(val) (36601.0)

• 3.2

• インスタンスメソッド

コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを設定します。

コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。

@param val パスを文字列で指定します。

• RDoc::Options

rdoc/generator (36547.0)

• 3.2

• ライブラリ

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
• rdoc/generator/darkfish
• rdoc/generator/json_index
• rdoc/generator/markup
• rdoc/generator/ri

絞り込み条件を変える

RDoc::RDoc#document(argv) -> nil (36355.0)

• 3.2

• インスタンスメソッド

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ
レクトリに出力します。

@param argv コマンドラインで rdoc コマンドに指定するのと同じ引数を文字
列の配列で指定します。

@raise RDoc::Error ドキュメントの処理中にエラーがあった場合に発生します。

指定できるオプションについては、lib:rdoc#usage を参照してくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の
doc 以下に出力します。

• RDoc::RDoc

RDoc::Options#write_options -> object (36349.0)

• 3.2

• インスタンスメソッド

カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式 で保存します。

カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式
で保存します。

• RDoc::Options

RDoc::RDoc.add_generator(klass) -> klass (36319.0)

• 3.2

• 特異メソッド

引数 klass で指定したクラスをジェネレータとして登録します。

引数 klass で指定したクラスをジェネレータとして登録します。

@param klass 登録するクラスを指定します。

@see c:RDoc::Options#custom_options

• RDoc::RDoc

Rake::RDocTask#rdoc_dir=(dir) (36304.0)

• 3.2

• インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名をセットします。

作成した HTML ファイルを保存するディレクトリ名をセットします。

• Rake::RDocTask

RDoc::Generator::Darkfish::GENERATOR_DIR -> String (36301.0)

• 3.2

• 定数

このファイルの親ディレクトリへのパスを表す文字列です。

このファイルの親ディレクトリへのパスを表す文字列です。

テンプレートなどのリソースを検索するのに内部で使用します。

• RDoc::Generator::Darkfish

絞り込み条件を変える

RDoc::Options#option_parser=(val) (36301.0)

• 3.2

• インスタンスメソッド

コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。

コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。

@param val OptionParser オブジェクトを指定します。

• OptionParser
• RDoc::Options

RDoc::Options#sanitize_path(path) (36301.0)

• 3.2

• インスタンスメソッド

ライブラリ内部で使用します。

ライブラリ内部で使用します。

• RDoc::Options

RDoc::Options#static_path -> [String] (36301.0)

• 3.2

• インスタンスメソッド

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し ます。

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。

• RDoc::Options

RDoc::Options#static_path=(vals) (36301.0)

• 3.2

• インスタンスメソッド

コマンドライン引数の --copy-files オプションと同様の指定を行います。

コマンドライン引数の --copy-files オプションと同様の指定を行います。

@param vals パスを文字列の配列で指定します。

• RDoc::Options

RDoc::Options#title -> String | nil (36301.0)

• 3.2

• インスタンスメソッド

ドキュメントのタイトルを返します。指定されていない場合は nil を返します。

ドキュメントのタイトルを返します。指定されていない場合は nil を返します。

• RDoc::Options

絞り込み条件を変える

RDoc::Options#title=(string) (36301.0)

• 3.2

• インスタンスメソッド

ドキュメントのタイトルがまだ設定されていない場合に string で指定した文 字列に設定します。

ドキュメントのタイトルがまだ設定されていない場合に string で指定した文
字列に設定します。

コマンドライン引数で既に --title オプションが指定されていた場合には、そ
ちらを優先します。

@param string 設定するタイトルを文字列で指定します。

• RDoc::Options

rake/rdoctask (36235.0)

• 3.2

• ライブラリ

ドキュメントを作成するためのタスクを定義します。

ドキュメントを作成するためのタスクを定義します。

以下のタスクを定義します。

: 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")
...

• Rake::RDocTask
• rake
• rake/tasklib

rdoc/context (36097.0)

• 3.2

• ライブラリ

RDoc::Context と RDoc::Context::Section を定義するサブライ ブラリです。

RDoc::Context と RDoc::Context::Section を定義するサブライ
ブラリです。

• RDoc::Context
• RDoc::Context::Section

rdoc/parser/ruby_tools (36097.0)

• 3.2

• ライブラリ

RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー ドのパーサを記述するためのモジュールを定義するサブライブラリです。

RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー
ドのパーサを記述するためのモジュールを定義するサブライブラリです。

• RDoc::Parser::RubyTools

rdoc/markup/to_ansi (36085.0)

• 3.2

• ライブラリ

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ ブラリです。

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ
ブラリです。

require 'rdoc/markup/to_ansi'

h = RDoc::Markup::ToAnsi.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。

• RDoc::Markup::ToAnsi

絞り込み条件を変える

rdoc/markup/to_bs (36085.0)

• 3.2

• ライブラリ

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるサブライブラリです。

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるサブライブラリです。

require 'rdoc/markup/to_bs'

h = RDoc::Markup::ToBs.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。実際に効果を確認するためにはページャ
などで出力を確認します。

テキスト中の以下のマークアップ記法をエスケープシーケンスの \b と組み合
わせる事によって見た目を変更します。

* イタリック体(_word_): word にアンダーラインを付けて...

• RDoc::Markup::ToBs

rdoc/markup/to_html (36085.0)

• 3.2

• ライブラリ

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

require 'rdoc/markup/to_html'

h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。

• RDoc::Markup::ToHtml
• rdoc/markup
• rdoc/markup/formatter

rdoc/markup/to_html_crossref (36067.0)

• 3.2

• ライブラリ

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。

• RDoc::Markup::ToHtmlCrossref
• rdoc/markup
• rdoc/markup/formatter
• rdoc/markup/to_html

rdoc/any_method (36049.0)

• 3.2

• ライブラリ

RDoc::AnyMethod を定義するサブライブラリです。

RDoc::AnyMethod を定義するサブライブラリです。

• RDoc::AnyMethod

rdoc/attr (36049.0)

• 3.2

• ライブラリ

RDoc::Attr を定義するサブライブラリです。

RDoc::Attr を定義するサブライブラリです。

• RDoc::Attr

絞り込み条件を変える

rdoc/code_object (36049.0)

• 3.2

• ライブラリ

RDoc::CodeObject を定義するサブライブラリです。

RDoc::CodeObject を定義するサブライブラリです。

• RDoc::CodeObject

rdoc/constant (36049.0)

• 3.2

• ライブラリ

RDoc::Constant を定義するサブライブラリです。

RDoc::Constant を定義するサブライブラリです。

• RDoc::Constant

rdoc/ghost_method (36049.0)

• 3.2

• ライブラリ

RDoc::GhostMethod を定義するサブライブラリです。

RDoc::GhostMethod を定義するサブライブラリです。

• RDoc::GhostMethod

rdoc/markup/formatter (36049.0)

• 3.2

• ライブラリ

RDoc 形式のドキュメントを整形するためのサブライブラリです。

RDoc 形式のドキュメントを整形するためのサブライブラリです。

• RDoc::Markup::Formatter
• rdoc/markup

rdoc/meta_method (36049.0)

• 3.2

• ライブラリ

RDoc::MetaMethod を定義するサブライブラリです。

RDoc::MetaMethod を定義するサブライブラリです。

• RDoc::MetaMethod

絞り込み条件を変える

rdoc/options (36049.0)

• 3.2

• ライブラリ

rdoc コマンドのオプションを解析するためのサブライブラリです。

rdoc コマンドのオプションを解析するためのサブライブラリです。

• RDoc::Options
• optparse
• pathname

rdoc/stats (36049.0)

• 3.2

• ライブラリ

RDoc のステータスを管理するサブライブラリです。

RDoc のステータスを管理するサブライブラリです。

• RDoc::Stats

rdoc/top_level (36049.0)

• 3.2

• ライブラリ

RDoc::TopLevel を定義するサブライブラリです。

RDoc::TopLevel を定義するサブライブラリです。

• RDoc::TopLevel

rdoc/generator/json_index (36037.0)

• 3.2

• ライブラリ

他のジェネレータが生成する 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::JsonIndex
• json

Rake::RDocTask (36001.0)

• 3.2

• クラス

絞り込み条件を変える

rdoc/code_objects (36001.0)

• 3.2

• ライブラリ

Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を 表現するためのサブライブラリです。

Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を
表現するためのサブライブラリです。

• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/constant
• rdoc/context
• rdoc/ghost_method
• rdoc/include
• rdoc/meta_method
• rdoc/normal_class
• rdoc/normal_module
• rdoc/require
• rdoc/single_class
• rdoc/top_level

rdoc/generator/darkfish (36001.0)

• 3.2

• ライブラリ

HTML を生成するためのサブライブラリです。

HTML を生成するためのサブライブラリです。

• RDoc::Generator::Darkfish
• erb
• fileutils
• pathname
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/generator
• rdoc/generator/markup
• rdoc/ghost_method
• rdoc/include
• rdoc/markup
• rdoc/markup/formatter
• rdoc/markup/to_html
• ...

rdoc/generator/markup (36001.0)

• 3.2

• ライブラリ

ライブラリ内部で使用します。

ライブラリ内部で使用します。

• RDoc::Generator::Markup
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/generator
• rdoc/ghost_method
• rdoc/include
• rdoc/markup
• rdoc/markup/formatter
• rdoc/markup/to_html
• rdoc/markup/to_html_crossref
• rdoc/meta_method
• rdoc/normal_class
• rdoc/normal_module
• ...

rdoc/generator/ri (36001.0)

• 3.2

• ライブラリ

ri のためのファイルを生成するためのサブライブラリです。

ri のためのファイルを生成するためのサブライブラリです。

• RDoc::Generator::RI

rdoc/parser/text (36001.0)

• 3.2

• ライブラリ

プログラムを含まないテキストを解析するためのサブライブラリです。

プログラムを含まないテキストを解析するためのサブライブラリです。

• RDoc::Parser::Text

絞り込み条件を変える

rdoc/text (36001.0)

• 3.2

• ライブラリ

コメントテキストを処理するためのサブライブラリです。

コメントテキストを処理するためのサブライブラリです。

• RDoc::Text

rdoc/token_stream (36001.0)

• 3.2

• ライブラリ

トークンを管理するためのサブライブラリです。

トークンを管理するためのサブライブラリです。

• RDoc::TokenStream

RDoc::Generator::Darkfish#initialize(store, options) -> RDoc::Generator::Darkfish (27988.0)

• 3.2

• インスタンスメソッド

RDoc::Generator::Darkfish オブジェクトを初期化します。

RDoc::Generator::Darkfish オブジェクトを初期化します。

@param store RDoc::Store オブジェクトを指定します。

@param options RDoc::Options オブジェクトを指定します。

• RDoc::Generator::Darkfish
• RDoc::Options
• RDoc::Store

RDoc::Generator::RI#initialize(store, options) -> RDoc::Generator::RI (27988.0)

• 3.2

• インスタンスメソッド

RDoc::Generator::RI オブジェクトを初期化します。

RDoc::Generator::RI オブジェクトを初期化します。

@param store RDoc::Store オブジェクトを指定します。

@param options RDoc::Options オブジェクトを指定します。

• RDoc::Generator::RI
• RDoc::Options
• RDoc::Store

RDoc::Context#constants -> [RDoc::Constant] (27952.0)

• 3.2

• インスタンスメソッド

追加された RDoc::Constant の配列を返します。

追加された RDoc::Constant の配列を返します。

• RDoc::Constant
• RDoc::Context

絞り込み条件を変える

RDoc::Context#each_constant {|c| ... } -> [RDoc::Constant] (27952.0)

• 3.2

• インスタンスメソッド

追加された RDoc::Constant に対してブロックを評価します。

追加された RDoc::Constant に対してブロックを評価します。

• RDoc::Constant
• RDoc::Context

RDoc::Context#each_method {|m| ... } -> [RDoc::AnyMethod] (27952.0)

• 3.2

• インスタンスメソッド

追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト) に対してブロックを評価します。

追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト)
に対してブロックを評価します。

• RDoc::AnyMethod
• RDoc::Context

RDoc::Context#method_list -> [RDoc::AnyMethod] (27952.0)

• 3.2

• インスタンスメソッド

追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列 を返します。

追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列
を返します。

• RDoc::AnyMethod
• RDoc::Context

RDoc::Context#sections -> RDoc::Context::Section (27952.0)

• 3.2

• インスタンスメソッド

追加された RDoc::Context::Section の配列を返します。

追加された RDoc::Context::Section の配列を返します。

• RDoc::Context
• RDoc::Context::Section

RDoc::Context#toplevel -> RDoc::TopLevel (27952.0)

• 3.2

• インスタンスメソッド

自身が所属する RDoc::TopLevel オブジェクトを返します。

自身が所属する RDoc::TopLevel オブジェクトを返します。

• RDoc::Context
• RDoc::TopLevel

絞り込み条件を変える

RDoc::Context::Section#parent -> RDoc::Context (27952.0)

• 3.2

• インスタンスメソッド

自身が所属する RDoc::Context オブジェクトを返します。

自身が所属する RDoc::Context オブジェクトを返します。

• RDoc::Context
• RDoc::Context::Section

RDoc::Markup#attribute_manager -> RDoc::AttributeManager (27952.0)

• 3.2

• インスタンスメソッド

自身の RDoc::AttributeManager オブジェクトを返します。

自身の RDoc::AttributeManager オブジェクトを返します。

• RDoc::AttributeManager
• RDoc::Markup

RDoc::Markup::ToRdoc.new(markup = nil) -> RDoc::Markup::ToRdoc (27922.0)

• 3.2

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。

• RDoc::Markup
• RDoc::Markup::ToRdoc

RDoc::CodeObject#parent -> RDoc::CodeObject (27904.0)

• 3.2

• インスタンスメソッド

自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。

自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。

• RDoc::CodeObject

RDoc::CodeObject#section -> RDoc::Context::Section (27904.0)

• 3.2

• インスタンスメソッド

所属している section を返します。

所属している section を返します。

• RDoc::CodeObject

絞り込み条件を変える

RDoc::Options#extra_accessor_flags -> {String => String} (27901.0)

• 3.2

• インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。

コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。

値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。

• RDoc::Options

RDoc::Context#add_method(a_method) -> () (27667.0)

• 3.2

• インスタンスメソッド

引数で指定した RDoc::AnyMethod オブジェクトを追加します。

引数で指定した RDoc::AnyMethod オブジェクトを追加します。

@param a_method RDoc::AnyMethod オブジェクトかそのサブクラスのオ
ブジェクトを指定します。

• RDoc::AnyMethod
• RDoc::Context

Rake::RDocTask#options=(options) (27667.0)

• 3.2

• インスタンスメソッド

rdoc コマンドに渡すオプションのリストをセットします。

rdoc コマンドに渡すオプションのリストをセットします。

@param options rdoc コマンドに渡されるオプションを指定します。

• Rake::RDocTask

RDoc::Markup::Formatter#add_tag(name, start, stop) -> () (27655.0)

• 3.2

• インスタンスメソッド

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::Markup::Formatter
• RDoc::Markup::ToHtml

RDoc::Context#unmatched_alias_lists -> {String => RDoc::Alias} (27652.0)

• 3.2

• インスタンスメソッド

メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。

メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。

• Hash
• RDoc::Alias
• RDoc::Context

絞り込み条件を変える

Rake::RDocTask#title=(title) (27649.0)

• 3.2

• インスタンスメソッド

RDoc のタイトルをセットします。

RDoc のタイトルをセットします。

@param title タイトルを指定します。

• Rake::RDocTask

RDoc::KNOWN_CLASSES -> {String => String} (27619.0)

• 3.2

• 定数

Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。

Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。

RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"

ライブラリの内部で使用します。

• RDoc

RDoc::Context#current_section -> RDoc::Context::Section (27604.0)

• 3.2

• インスタンスメソッド

現在の section を返します。

現在の section を返します。

• RDoc::Context

RDoc::Options#generator -> Generator (27601.0)

• 3.2

• インスタンスメソッド

コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。

コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。

指定しなかった場合は、HTML に対応する Generator を返します。

• RDoc::Options

RDoc::Text#strip_hashes(text) -> String (27601.0)

• 3.2

• インスタンスメソッド

引数から各行の行頭の # を削除します。

引数から各行の行頭の # を削除します。

@param text 文字列を指定します。

• RDoc::Text

絞り込み条件を変える

RDoc::Text#strip_newlines(text) -> String (27601.0)

• 3.2

• インスタンスメソッド

引数から先頭と末尾の改行を削除します。

引数から先頭と末尾の改行を削除します。

@param text 文字列を指定します。

• RDoc::Text

RDoc::Text#strip_stars(text) -> String (27601.0)

• 3.2

• インスタンスメソッド

引数から /* 〜 */ 形式のコメントを削除します。

引数から /* 〜 */ 形式のコメントを削除します。

@param text 文字列を指定します。

• RDoc::Text

RDoc::TopLevel#file_stat -> File::Stat (27601.0)

• 3.2

• インスタンスメソッド

自身が管理するファイルに関する File::Stat オブジェクトを返します。

自身が管理するファイルに関する File::Stat オブジェクトを返します。

• File::Stat
• RDoc::TopLevel

RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> () (27433.0)

• 3.2

• インスタンスメソッド

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::AnyMethod
• RDoc::Attr
• RDoc::Context

RDoc::Context#add_to(array, thing) -> () (27427.0)

• 3.2

• インスタンスメソッド

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

絞り込み条件を変える