検索結果

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

• 3.1

• インスタンスメソッド

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

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

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

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

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

• 3.1

• インスタンスメソッド

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

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

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

@see RDoc::Text#normalize_comment

• RDoc::Text

RDoc::Parser::C.new(top_level, file_name, body, options, stats) -> RDoc::Parser::C (9358.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::Ruby.new(top_level, file_name, body, options, stats) -> RDoc::Parser::Ruby (9358.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.new(top_level, file_name, body, options, stats) -> RDoc::Parser::Simple (9358.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::Context#aliases -> [RDoc::Alias] (9352.0)

• 3.1

• インスタンスメソッド

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

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

• RDoc::Alias
• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Attr
• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Constant
• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Attr
• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Constant
• RDoc::Context

絞り込み条件を変える

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::AnyMethod
• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

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

• RDoc::Context
• RDoc::NormalModule

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Context
• RDoc::Include

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::AnyMethod
• RDoc::Context

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Context
• RDoc::NormalModule

絞り込み条件を変える

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Context
• RDoc::Require

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

• 3.1

• インスタンスメソッド

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

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

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

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Context
• RDoc::TopLevel

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

• 3.1

• インスタンスメソッド

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

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

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

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

• 3.1

• インスタンスメソッド

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

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

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

絞り込み条件を変える

RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document (9352.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 (9352.0)

• 3.1

• 特異メソッド

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

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

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

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

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::AttributeManager
• RDoc::Markup

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

• 3.1

• 特異メソッド

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

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

• RDoc::Parser

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

• 3.1

• インスタンスメソッド

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

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

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

• RDoc::TopLevel

絞り込み条件を変える

RDoc::CodeObject (9337.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::Context::Section.new(parent, title, comment) -> RDoc::Context::Section (9322.0)

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

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

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

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

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

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

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

• RDoc::Markup
• Rdoc::AttributeManager

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

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

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

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

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

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

絞り込み条件を変える

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

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

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

RDoc::Markup::ToHtmlCrossref.new(path, context, show_hash) -> RDoc::Markup::ToHtmlCrossref (9322.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::C#scan -> RDoc::TopLevel (9322.0)

• 3.1

• インスタンスメソッド

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

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

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

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

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

• 3.1

• インスタンスメソッド

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

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

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

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

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

• 3.1

• インスタンスメソッド

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

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

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

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

絞り込み条件を変える

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

• 3.1

• インスタンスメソッド

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

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

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

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

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

• 3.1

• インスタンスメソッド

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

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

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

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

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::CodeObject

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::CodeObject

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

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

• RDoc::CodeObject

絞り込み条件を変える

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

• 3.1

• インスタンスメソッド

現在の section を返します。

現在の section を返します。

• RDoc::Context

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

• 3.1

• インスタンスメソッド

find a module at a higher scope

find a module at a higher scope

• RDoc::Context

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

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

• RDoc::Context

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

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

• RDoc::Markup::ToHtml

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

• 3.1

• 特異メソッド

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

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

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

• RDoc::Parser

絞り込み条件を変える

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

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

• RDoc::Stats

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

• 3.1

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

• RDoc::TopLevel

RDoc::Options (9283.0)

• 3.1

• クラス

rdoc コマンドのオプションを解析するためのクラスです。

rdoc コマンドのオプションを解析するためのクラスです。

それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。


===[a:custom_options] カスタムオプション

RDoc のジェネレータでは、RDoc::Options をフックして独自の
オプションを指定できます。

Object::ARGV に --format が含まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要が...

• RDoc
• RDoc::Options

RDoc::Markup (9175.0)

• 3.1

• クラス

RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。

RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。

例:

require 'rdoc/markup/to_html'

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

独自のフォーマットを行うようにパーサを拡張する事もできます。


例:

require 'rdoc/markup'
require 'rdoc/markup/to_html'

class WikiHtml < RDoc::Markup::ToHtml
# WikiWord のフォントを赤く表示。
...

• RDoc::Markup::ToHtml

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

• 3.1

• インスタンスメソッド

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) -> () (9127.0)

• 3.1

• インスタンスメソッド

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

RDoc::Context#add_require(a_require) -> () (9115.0)

• 3.1

• インスタンスメソッド

自身が所属する RDoc::TopLevel オブジェクトに引数で指定した RDoc::Require を追加します。

自身が所属する RDoc::TopLevel オブジェクトに引数で指定した
RDoc::Require を追加します。

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

• RDoc::Context
• RDoc::Require
• RDoc::TopLevel

RDoc::Parser::RubyTools (9115.0)

• 3.1

• モジュール

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

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

RDoc::Parser を継承していないため、パーサクラスとしては利用できま
せん。

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

• RDoc::Parser
• RDoc::RubyLex
• RDoc::RubyToken

RDoc::CodeObject#start_doc -> () (9103.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 -> () (9103.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::Generator (9097.0)

• 3.1

• モジュール

RDoc が解析したソースコードを RDoc::CodeObject のツリーから その他の形式に出力するためのクラスです。

RDoc が解析したソースコードを RDoc::CodeObject のツリーから
その他の形式に出力するためのクラスです。

• RDoc
• RDoc::CodeObject

RDoc::TopLevel.reset -> () (9097.0)

• 3.1

• 特異メソッド

RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイ ル)をクリアします。

RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイ
ル)をクリアします。

• RDoc::TopLevel

RDoc::Text#normalize_comment(text) -> String (9073.0)

• 3.1

• インスタンスメソッド

引数から行頭のスペースや改行文字などを削除します。

引数から行頭のスペースや改行文字などを削除します。

詳しくは [SEE ALSO] の各メソッドを参照してください。

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

@see RDoc::Text#strip_hashes, RDoc::Text#expand_tabs,
RDoc::Text#flush_left, RDoc::Text#strip_newlines

• RDoc::Text

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

• 3.1

• インスタンスメソッド

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

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

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

• RDoc::Attr
• RDoc::Context

RDoc::Context#add_constant(const) -> () (9067.0)

• 3.1

• インスタンスメソッド

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

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

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

• RDoc::Constant
• RDoc::Context

絞り込み条件を変える

RDoc::Context#add_include(an_include) -> () (9067.0)

• 3.1

• インスタンスメソッド

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

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

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

• RDoc::Context
• RDoc::Include

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

• 3.1

• インスタンスメソッド

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

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

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

• RDoc::AnyMethod
• RDoc::Context

RDoc::Context#unmatched_alias_lists=(val) (9067.0)

• 3.1

• インスタンスメソッド

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

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

@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。

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

RDoc::Markup::Formatter (9067.0)

• 3.1

• クラス

RDoc 形式のドキュメントを整形するための基本クラスです。

RDoc 形式のドキュメントを整形するための基本クラスです。

実際にドキュメントを整形するには、RDoc::Markup::ToHtml のような、
継承したクラスで convert メソッドを実行してください。

• RDoc::Markup::ToHtml

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

• 3.1

• インスタンスメソッド

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

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

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

• Rake::RDocTask

絞り込み条件を変える

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

• 3.1

• インスタンスメソッド

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::Parser::Text (9055.0)

• 3.1

• モジュール

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

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

単体では使用せず、RDoc::Parser のサブクラスで RDoc::Parser::Text
を include する事で、プログラムを含んでいない事を rdoc に伝えます。

• RDoc::Parser
• rdoc

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::CodeObject

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::CodeObject

RDoc::Context (9049.0)

• 3.1

• クラス

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

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

• rdoc/code_objects

絞り込み条件を変える

RDoc::Generator::JsonIndex#generate -> () (9049.0)

• 3.1

• インスタンスメソッド

解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出 力します。

解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。

• RDoc::Generator::JsonIndex

RDoc::Markdown (9049.0)

• 3.1

• クラス

Markdown 形式で記述されたドキュメントを rdoc 上で解析するための クラスです。

Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
クラスです。

• rdoc

RDoc::Markdown.new(extensions = DEFAULT_EXTENSIONS, debug = false) (9049.0)

• 3.1

• 特異メソッド

引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブ ジェクトを初期化します。

引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブ
ジェクトを初期化します。

@param extensions 有効にする拡張を Symbol の配列で指定します。

@param debug デバッグを有効にするかどうかを指定します。

• RDoc::Markdown
• Symbol

RDoc::Markdown::HTML_ENTITIES -> {String => [Integer]} (9049.0)

• 3.1

• 定数

HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。

HTML の実体参照のマッピングを表す Hash オブジェクトです。
RDoc::Markdown で使用します。

• Hash
• RDoc::Markdown

RDoc::Markup::ToAnsi (9049.0)

• 3.1

• クラス

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

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

絞り込み条件を変える

RDoc::Markup::ToBs (9049.0)

• 3.1

• クラス

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

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

RDoc::Markup::ToHtml (9049.0)

• 3.1

• クラス

RDoc 形式のドキュメントを HTML に整形するクラスです。

RDoc 形式のドキュメントを HTML に整形するクラスです。

RDoc::Markup::ToHtmlCrossref (9049.0)

• 3.1

• クラス

RDoc 形式のドキュメントを HTML に整形するクラスです。

RDoc 形式のドキュメントを HTML に整形するクラスです。

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

• 3.1

• インスタンスメソッド

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

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

• RDoc::Options

RDoc::Options::SPECIAL -> [String] (9049.0)

• 3.1

• 定数

--write-options を指定した際に .rdoc_options ファイルに保存されないオプ ションの一覧を返します。

--write-options を指定した際に .rdoc_options ファイルに保存されないオプ
ションの一覧を返します。

• RDoc::Options

絞り込み条件を変える

RDoc::Parser::Ruby::NORMAL -> "::" (9049.0)

• 3.1

• 定数

RDoc::NormalClass type

RDoc::NormalClass type

• RDoc::Parser::Ruby

RDoc::Parser::Ruby::SINGLE -> "<<" (9049.0)

• 3.1

• 定数

RDoc::SingleClass type

RDoc::SingleClass type

• RDoc::Parser::Ruby

RDoc::Stats (9049.0)

• 3.1

• クラス

RDoc のステータスを管理するクラスです。

RDoc のステータスを管理するクラスです。

Rake::RDocTask#external -> bool (9049.0)

• 3.1

• インスタンスメソッド

この値が真の場合は外部のシェル経由で rdoc コマンドを実行します。 デフォルトは偽です。

この値が真の場合は外部のシェル経由で rdoc コマンドを実行します。
デフォルトは偽です。

• Rake::RDocTask

Rake::RDocTask#external=(flag) (9049.0)

• 3.1

• インスタンスメソッド

外部のシェル経由で rdoc コマンドを実行するかどうかセットします。

外部のシェル経由で rdoc コマンドを実行するかどうかセットします。

@param flag 真または偽を指定します。

• Rake::RDocTask

絞り込み条件を変える

Rake::RDocTask#name -> String (9049.0)

• 3.1

• インスタンスメソッド

タスクの名前を返します。デフォルトは rdoc です。

タスクの名前を返します。デフォルトは rdoc です。

• Rake::RDocTask

Rake::RDocTask#option_list -> Array (9049.0)

• 3.1

• インスタンスメソッド

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

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

• Rake::RDocTask

Rake::RDocTask#option_string -> String (9049.0)

• 3.1

• インスタンスメソッド

rdoc コマンドに渡すオプションを文字列として返します。

rdoc コマンドに渡すオプションを文字列として返します。

• Rake::RDocTask

Rake::RDocTask#options -> Array (9049.0)

• 3.1

• インスタンスメソッド

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

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

指定できるオプションは -o, --main, --title, -T 以外です。

• Rake::RDocTask

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

• 3.1

• インスタンスメソッド

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

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

• Rake::RDocTask

絞り込み条件を変える

Rake::RDocTask#title -> String (9049.0)

• 3.1

• インスタンスメソッド

RDoc のタイトルを返します。 デフォルト値はありません。

RDoc のタイトルを返します。
デフォルト値はありません。

• Rake::RDocTask

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

• 3.1

• インスタンスメソッド

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

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

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

• Rake::RDocTask

RDoc::CodeObject#document_children=(val) (9037.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=(val) (9037.0)

• 3.1

• インスタンスメソッド

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

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

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

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

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

• RDoc::CodeObject

RDoc::Markup#add_html(tag, name) -> () (9037.0)

• 3.1

• インスタンスメソッド

tag で指定したタグをフォーマットの対象にします。

tag で指定したタグをフォーマットの対象にします。

@param tag 追加するタグ名を文字列で指定します。大文字、小文字のど
ちらを指定しても同一のものとして扱われます。

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

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_ht...

• RDoc::Markup
• SM::ToHtml

絞り込み条件を変える

RDoc::Markup#add_special(pattern, name) -> () (9037.0)

• 3.1

• インスタンスメソッド

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

RDoc::Markup#add_word_pair(start, stop, name) -> () (9037.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::Parser#parse_files_matching(regexp) -> () (9037.0)

• 3.1

• インスタンスメソッド

regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。

regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、
自身を登録します。

@param regexp 正規表現を指定します。

新しいパーサを作成する時に使用します。

例:

class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end

• RDoc::Parser

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

• 3.1

• インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self

• RDoc::CodeObject

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

• 3.1

• インスタンスメソッド

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

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

@see RDoc::CodeObject#document_children

• RDoc::CodeObject

絞り込み条件を変える