検索結果

RDoc::Parser::RD (123049.0)

• 3.1

• クラス

RD 形式で記述されたファイルを解析するためのクラスです。

RD 形式で記述されたファイルを解析するためのクラスです。

解析された情報はコメントとして扱われます。

RDoc::Context#record_location(toplevel) (87301.0)

• 3.1

• インスタンスメソッド

Record the file that we happen to find it in

Record the file that we happen to find it in

• RDoc::Context

RDoc::Markup#add_word_pair(start, stop, name) -> () (87301.0)

• 3.1

• インスタンスメソッド

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま
す。

@param start 開始となる文字列を指定します。

@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。

例:

require 'rdoc/markup/...

• RDoc::Markup
• SM::ToHtml

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

• 3.1

• インスタンスメソッド

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

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

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

• RDoc::Options

RDoc::Markup::ToRdoc (87001.0)

• 3.1

• クラス

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

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

絞り込み条件を変える

RDoc::RDoc (87001.0)

• 3.1

• クラス

rdoc ドキュメントの作成を行うクラスです。

rdoc ドキュメントの作成を行うクラスです。

以下のようにして、rdoc コマンドを実行するのと同様に実行します。

require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)

args には rdoc コマンドに渡すのと同様の引数を文字列の配列で指定します。

rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを
HTML に変換する部分をライブラリとして使用したい場合、
rdoc/markup を参照してください。

• rdoc/markup

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

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

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

struct RData * RDATA(VALUE obj) (78601.0)

• 3.1

• マクロ

RDoc::Parser::RD#scan -> RDoc::TopLevel (78349.0)

• 3.1

• インスタンスメソッド

RD 形式で記述されたファイルを解析します。

RD 形式で記述されたファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::RD
• RDoc::TopLevel

RDoc (78001.0)

• 3.1

• モジュール

rdoc ドキュメントを扱うためのモジュールです。

rdoc ドキュメントを扱うためのモジュールです。

絞り込み条件を変える

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

• 3.1

• インスタンスメソッド

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

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

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

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

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

• RDoc::RDoc

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

• 3.1

• 特異メソッド

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

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

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

@see c:RDoc::Options#custom_options

• RDoc::RDoc

RDoc::TopLevel#find_local_symbol(name) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule | RDoc::AnyMethod | RDoc::Alias | RDoc::Attr | RDoc::Constant (71101.0)

• 3.1

• インスタンスメソッド

クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。

クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。

• RDoc::TopLevel

RDoc::Context#add_class_or_module(collection, class_type, name, superclass = nil) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (69901.0)

• 3.1

• インスタンスメソッド

collection に name で指定したクラス、モジュールを追加します。

collection に name で指定したクラス、モジュールを追加します。

@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param su...

• Hash
• RDoc::Context
• RDoc::NormalClass

RDoc::Context#add_module(class_type, name) -> RDoc::NormalModule | RDoc::SingleClass | RDoc::NormalClass (69901.0)

• 3.1

• インスタンスメソッド

引数で指定したモジュールを追加します。

引数で指定したモジュールを追加します。

ただし、クラスとして既に同名のものが登録されていた場合は、何もせずにそ
のクラスを返します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@see RDoc::Context#add_class

• RDoc::Context
• RDoc::NormalClass

絞り込み条件を変える

RDoc::Context#each_classmodule {|m| ... } -> [RDoc::SingleClass | RDoc::NormalClass | RDoc::NormalModule] (69901.0)

• 3.1

• インスタンスメソッド

追加されたクラス、モジュールに対してブロックを評価します。

追加されたクラス、モジュールに対してブロックを評価します。

@see RDoc::Context#classes, RDoc::Context#modules

• RDoc::Context

RDoc::TopLevel#add_class_or_module(collection, class_type, name, superclass) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (69901.0)

• 3.1

• インスタンスメソッド

collection に name で指定したクラス、モジュールを追加します。

collection に name で指定したクラス、モジュールを追加します。

@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param su...

• Hash
• RDoc::NormalClass
• RDoc::TopLevel

RDoc::TopLevel.all_classes_and_modules -> [RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule] (69901.0)

• 3.1

• 特異メソッド

RDoc が収集したクラス、モジュールを配列で返します。

RDoc が収集したクラス、モジュールを配列で返します。

• RDoc::TopLevel

RDoc::Context#add_class(class_type, name, superclass) -> RDoc::SingleClass | RDoc::NormalClass (69601.0)

• 3.1

• インスタンスメソッド

引数で指定したクラスを追加します。

引数で指定したクラスを追加します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param superclass 追加するクラスの親クラスを RDoc::NormalClass オ
ブジェクトで指定します。

• RDoc::Context
• RDoc::NormalClass

RDoc::Context#classes -> [RDoc::SingleClass | RDoc::NormalClass] (69601.0)

• 3.1

• インスタンスメソッド

追加されたクラスの配列を返します。

追加されたクラスの配列を返します。

• RDoc::Context

絞り込み条件を変える

RDoc::TopLevel.find_class_named(name) -> RDoc::NormalClass | RDoc::SingleClass | nil (69601.0)

• 3.1

• 特異メソッド

RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ からなかった場合は nil を返します。

RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ
からなかった場合は nil を返します。

@param name クラス名を文字列で指定します。

• RDoc::TopLevel

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::CodeObject

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::CodeObject

RDoc::CodeObject.new -> RDoc::CodeObject (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

• RDoc::CodeObject

RDoc::Context#add_alias(an_alias) -> RDoc::Alias (69301.0)

• 3.1

• インスタンスメソッド

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

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

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

• RDoc::Alias
• RDoc::Context

絞り込み条件を変える

RDoc::Context#aliases -> [RDoc::Alias] (69301.0)

• 3.1

• インスタンスメソッド

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

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

• RDoc::Alias
• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Attr
• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Constant
• RDoc::Context

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

• 3.1

• インスタンスメソッド

現在の section を返します。

現在の section を返します。

• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Attr
• RDoc::Context

絞り込み条件を変える

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Constant
• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::AnyMethod
• RDoc::Context

RDoc::Context#find_enclosing_module_named(name) -> RDoc::NormalModule | nil (69301.0)

• 3.1

• インスタンスメソッド

find a module at a higher scope

find a module at a higher scope

• RDoc::Context

RDoc::Context#find_module_named(name) -> RDoc::NormalModule | nil (69301.0)

• 3.1

• インスタンスメソッド

追加された RDoc::NormalModule から引数で指定した名前のモジュール を検索します。見つからなかった場合は nil を返します。

追加された RDoc::NormalModule から引数で指定した名前のモジュール
を検索します。見つからなかった場合は nil を返します。

@param name モジュールの名前を文字列で指定します。

• RDoc::Context
• RDoc::NormalModule

RDoc::Context#includes -> [RDoc::Include] (69301.0)

• 3.1

• インスタンスメソッド

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

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

• RDoc::Context
• RDoc::Include

絞り込み条件を変える

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::AnyMethod
• RDoc::Context

RDoc::Context#modules -> [RDoc::NormalModule] (69301.0)

• 3.1

• インスタンスメソッド

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

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

• RDoc::Context
• RDoc::NormalModule

RDoc::Context#requires -> [RDoc::Require] (69301.0)

• 3.1

• インスタンスメソッド

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

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

• RDoc::Context
• RDoc::Require

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

• 3.1

• インスタンスメソッド

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

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

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

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Context
• RDoc::TopLevel

絞り込み条件を変える

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

• 3.1

• インスタンスメソッド

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

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

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

RDoc::Context.new -> RDoc::Context (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

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

RDoc::Context::Section.new(parent, title, comment) -> RDoc::Context::Section (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

@param title section のタイトルを文字列で指定します。

@param comment section のコメントを文字列で指定します。

また、section のシーケンス番号を新しく作成します。

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

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

• 3.1

• インスタンスメソッド

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

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

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

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

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

絞り込み条件を変える

RDoc::Generator::JsonIndex.new(parent_generator, options) -> RDoc::Generator::JsonIndex (69301.0)

• 3.1

• 特異メソッド

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

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

@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します。
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。

@...

• RDoc::Generator::JsonIndex
• RDoc::Options

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

• 3.1

• インスタンスメソッド

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

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

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

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

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

RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document (69301.0)

• 3.1

• インスタンスメソッド

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。

@param markdown 解析の対象になるドキュメントを文字列で指定します。

• RDoc::Markdown
• RDoc::Markup::Document

RDoc::Markdown.parse(markdown) -> RDoc::Markup::Document (69301.0)

• 3.1

• 特異メソッド

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。

@param markdown 解析の対象になるドキュメントを文字列で指定します。

• RDoc::Markdown
• RDoc::Markup::Document

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::AttributeManager
• RDoc::Markup

絞り込み条件を変える

RDoc::Markup.new(attribute_manager = nil) -> RDoc::Markup (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param attribute_manager Rdoc::AttributeManager オブジェクトを指
定します。

• RDoc::Markup
• Rdoc::AttributeManager

RDoc::Markup::Formatter.new(markup = nil) -> RDoc::Markup::Formatter (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

• RDoc::Markup
• RDoc::Markup::Formatter

RDoc::Markup::ToAnsi.new(markup = nil) -> RDoc::Markup::ToAnsi (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

• RDoc::Markup
• RDoc::Markup::ToAnsi

RDoc::Markup::ToBs.new(markup = nil) -> RDoc::Markup::ToBs (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

• RDoc::Markup
• RDoc::Markup::ToBs

RDoc::Markup::ToHtml.new -> RDoc::Markup::ToHtml (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

• RDoc::Markup::ToHtml

絞り込み条件を変える

RDoc::Markup::ToHtmlCrossref.new(path, context, show_hash) -> RDoc::Markup::ToHtmlCrossref (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param path 生成するファイルのパスを文字列で指定します。

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

@param show_hash true を指定した場合、メソッド名のリンクに # を表示しま
す。false の場合は表示しません。

@raise ArgumentError path に nil を指定した場合に発生します。

• RDoc::Context
• RDoc::Markup::ToHtmlCrossref

RDoc::Parser.can_parse(file_name) -> RDoc::Parser | nil (69301.0)

• 3.1

• 特異メソッド

file_name を解析できるパーサクラスを返します。見つからなかった場合は nil を返します。

file_name を解析できるパーサクラスを返します。見つからなかった場合は
nil を返します。

@param file_name 解析するファイルの名前を指定します。

• RDoc::Parser

RDoc::Parser.parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser (69301.0)

• 3.1

• 特異メソッド

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::Options
• RDoc::Parser
• RDoc::Parser::Simple
• RDoc::Stats
• RDoc::TopLevel

RDoc::Parser.parsers -> [[Regexp, RDoc::Parser]] (69301.0)

• 3.1

• 特異メソッド

RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラ スの配列の配列を返します。

RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラ
スの配列の配列を返します。

• RDoc::Parser

RDoc::Parser::C#scan -> RDoc::TopLevel (69301.0)

• 3.1

• インスタンスメソッド

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析します。

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析します。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::C
• RDoc::TopLevel

絞り込み条件を変える

RDoc::Parser::C.new(top_level, file_name, body, options, stats) -> RDoc::Parser::C (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

@param file_name ファイル名を文字列で指定します。

@param body ソースコードの内容を文字列で指定します。

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

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

• RDoc::Options
• RDoc::Parser::C
• RDoc::Stats
• RDoc::TopLevel

RDoc::Parser::ChangeLog#scan -> RDoc::TopLevel (69301.0)

• 3.1

• インスタンスメソッド

ChangeLog ファイルを解析します。

ChangeLog ファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::ChangeLog
• RDoc::TopLevel

RDoc::Parser::Markdown#scan -> RDoc::TopLevel (69301.0)

• 3.1

• インスタンスメソッド

Markdown 形式で記述されたファイルを解析します。

Markdown 形式で記述されたファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::Markdown
• RDoc::TopLevel

RDoc::Parser::Ruby#scan -> RDoc::TopLevel (69301.0)

• 3.1

• インスタンスメソッド

Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::Ruby
• RDoc::TopLevel

RDoc::Parser::Ruby.new(top_level, file_name, body, options, stats) -> RDoc::Parser::Ruby (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

@param file_name ファイル名を文字列で指定します。

@param body ソースコードの内容を文字列で指定します。

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

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

• RDoc::Options
• RDoc::Parser::Ruby
• RDoc::Stats
• RDoc::TopLevel

絞り込み条件を変える

RDoc::Parser::Simple#scan -> RDoc::TopLevel (69301.0)

• 3.1

• インスタンスメソッド

自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し ます。

自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し
ます。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::Simple
• RDoc::TopLevel

RDoc::Parser::Simple.new(top_level, file_name, body, options, stats) -> RDoc::Parser::Simple (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

@param file_name ファイル名を文字列で指定します。

@param body 内容を文字列で指定します。

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

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

• RDoc::Options
• RDoc::Parser::Simple
• RDoc::Stats
• RDoc::TopLevel

RDoc::Stats.new -> RDoc::Stats (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

• RDoc::Stats

RDoc::Text#parse(text) -> RDoc::Markup::Document | Array (69301.0)

• 3.1

• インスタンスメソッド

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。

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

@see RDoc::Text#normalize_comment

• RDoc::Text

RDoc::TopLevel#find_module_named(name) -> RDoc::NormalModule (69301.0)

• 3.1

• インスタンスメソッド

RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。 見つからなかった場合は nil を返します。

RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。
見つからなかった場合は nil を返します。

@param name モジュール名を文字列で指定します。

• RDoc::TopLevel

絞り込み条件を変える

RDoc::TopLevel.new(file_name) -> RDoc::TopLevel (69301.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param file_name ファイル名を文字列で指定します。

• RDoc::TopLevel

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

• 3.1

• 定数

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

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

• RDoc

RDoc::Alias (69001.0)

• 3.1

• クラス

aliasされたメソッドを表現するクラスです。

aliasされたメソッドを表現するクラスです。


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

RDoc::AnonClass (69001.0)

• 3.1

• クラス

匿名クラスを表現するクラスです。

匿名クラスを表現するクラスです。

現在は使用されていません。

RDoc::AnyMethod (69001.0)

• 3.1

• クラス

メソッドを表現するクラスの基本クラスです。

メソッドを表現するクラスの基本クラスです。

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

絞り込み条件を変える

RDoc::Attr (69001.0)

• 3.1

• クラス

属性を表現するクラスです。

属性を表現するクラスです。

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

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

• 3.1

• 定数

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

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

• RDoc

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

• 3.1

• 定数

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

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

• RDoc

RDoc::ClassModule (69001.0)

• 3.1

• クラス

クラスやモジュールを表現するための基本クラスです。

クラスやモジュールを表現するための基本クラスです。

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

RDoc::CodeObject (69001.0)

• 3.1

• クラス

RDoc のコードツリーを表現するクラスの基本クラスです。

RDoc のコードツリーを表現するクラスの基本クラスです。

以下は RDoc::CodeObject のサブクラスのツリーです。

//emlist{
* RDoc::Context
* RDoc::TopLevel
* RDoc::ClassModule
* RDoc::AnonClass
* RDoc::NormalClass
* RDoc::NormalModule
* RDoc::SingleClass
* RDoc::AnyMethod
* RDoc::GhostMethod
* RDoc::MetaMethod
...

• RDoc::CodeObject

絞り込み条件を変える

RDoc::CodeObject#comment -> String (69001.0)

• 3.1

• インスタンスメソッド

自身のコメントを返します。

自身のコメントを返します。

• RDoc::CodeObject

RDoc::CodeObject#comment=(comment) (69001.0)

• 3.1

• インスタンスメソッド

自身のコメントを comment に設定します。

自身のコメントを comment に設定します。

ただし、comment が空文字列だった場合は何もしません。

@param comment コメントを文字列で指定します。

• RDoc::CodeObject

RDoc::CodeObject#document_children -> bool (69001.0)

• 3.1

• インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを返します。

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを返します。

@see RDoc::CodeObject#document_self

• RDoc::CodeObject

RDoc::CodeObject#document_children=(val) (69001.0)

• 3.1

• インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを設定します。

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを設定します。

:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、上記をドキュメントに含めます。

@see RDoc::CodeObject#document_self=,
RDoc::CodeObject#remove_classes_and_modules

• RDoc::CodeObject

RDoc::CodeObject#document_self -> bool (69001.0)

• 3.1

• インスタンスメソッド

自身をドキュメントに含めるかどうかを返します。

自身をドキュメントに含めるかどうかを返します。

@see RDoc::CodeObject#document_children

• RDoc::CodeObject

絞り込み条件を変える

RDoc::CodeObject#document_self=(val) (69001.0)

• 3.1

• インスタンスメソッド

自身をドキュメントに含めるかどうかを設定します。

自身をドキュメントに含めるかどうかを設定します。

:doc: を指定した時に true が設定されます。
:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、自身をドキュメントに含めます。

@see RDoc::CodeObject#document_children=,
RDoc::CodeObject#remove_methods_etc

• RDoc::CodeObject

RDoc::CodeObject#documented? -> bool (69001.0)

• 3.1

• インスタンスメソッド

出力すべきドキュメントがあるかどうかを返します。

出力すべきドキュメントがあるかどうかを返します。

• RDoc::CodeObject

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::CodeObject

RDoc::CodeObject#parent=(val) (69001.0)

• 3.1

• インスタンスメソッド

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

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

@param val RDoc::CodeObject のサブクラスのオブジェクトを指定しま
す。

• RDoc::CodeObject

RDoc::CodeObject#parent_file_name -> String (69001.0)

• 3.1

• インスタンスメソッド

self.parent のファイル名を返します。

self.parent のファイル名を返します。

@see RDoc::CodeObject#parent

• RDoc::CodeObject

絞り込み条件を変える

RDoc::CodeObject#parent_name -> String (69001.0)

• 3.1

• インスタンスメソッド

self.parent の名前を返します。

self.parent の名前を返します。

@see RDoc::CodeObject#parent

• RDoc::CodeObject

RDoc::CodeObject#remove_classes_and_modules -> () (69001.0)

• 3.1

• インスタンスメソッド

何もしません。RDoc::CodeObject#document_children= に false を指定 した時のコールバックとして呼び出されます。オーバーライドして使用します。

何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。

• RDoc::CodeObject

RDoc::CodeObject#remove_methods_etc -> () (69001.0)

• 3.1

• インスタンスメソッド

何もしません。RDoc::CodeObject#document_self= に false を指定した 時のコールバックとして呼び出されます。オーバーライドして使用します。

何もしません。RDoc::CodeObject#document_self= に false を指定した
時のコールバックとして呼び出されます。オーバーライドして使用します。

• RDoc::CodeObject

RDoc::CodeObject#section=(val) (69001.0)

• 3.1

• インスタンスメソッド

所属する section を設定します。

所属する section を設定します。

@param val RDoc::Context::Section オブジェクトを指定します。

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

RDoc::CodeObject#start_doc -> () (69001.0)

• 3.1

• インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで の間、ドキュメントに含めます。

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで
の間、ドキュメントに含めます。

:startdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を true に設定します。

@see RDoc::CodeObject#end_doc

• RDoc::CodeObject

絞り込み条件を変える

RDoc::CodeObject#stop_doc -> () (69001.0)

• 3.1

• インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま での間、ドキュメントに含めません。

以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま
での間、ドキュメントに含めません。

:stopdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を false に設定します。

@see RDoc::CodeObject#start_doc

• RDoc::CodeObject

RDoc::Constant (69001.0)

• 3.1

• クラス

定数を表現するクラスです。

定数を表現するクラスです。

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

RDoc::Context (69001.0)

• 3.1

• クラス

モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す るクラスを管理するクラスです。

モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す
るクラスを管理するクラスです。

• rdoc/code_objects

RDoc::Context#<=>(other) -> -1 | 0 | 1 (69001.0)

• 3.1

• インスタンスメソッド

自身と other の full_name を比較した結果を返します。

自身と other の full_name を比較した結果を返します。

ソートのために使われます。

@param other 自身と比較したいオブジェクトを指定します。

• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

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

• RDoc::Attr
• RDoc::Context

絞り込み条件を変える