バージョン:2.3.0 > ライブラリ:rdoc > クエリ:RDoc

302件ヒット [1-100件を表示] （0.051秒）

トップページ >

:2.3.0

:rdoc

:RDoc

別のキーワード

種類

クラス

モジュール

RDoc (8)
RDoc::Text (8)

キーワード

検索結果

<< 1 2 3 ... > >>

RDoc (114055.0)

2.3.0

モジュール

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

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

RDoc::RDoc (63232.0)

2.3.0

クラス

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

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

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

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

args には rdoc コマンドに渡すのと同様の引数を文字列...

...の配列で指定します。

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

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

2.3.0

定数

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

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

RDoc::VERSION -> String (63055.0)

2.3.0

定数

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

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

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

2.3.0

定数

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

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

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

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

絞り込み条件を変える

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

2.3.0

定数

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

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

2.3.0

定数

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

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

2.3.0

定数

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

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

2.3.0

定数

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

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

2.3.0

定数

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

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

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

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

RDoc::Markup::ToRdoc (27052.0)

2.3.0

クラス

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

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

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

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

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

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

2.3.0

インスタンスメソッド

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

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

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

指定できるオプションについては、lib:rdoc#usage を参照し...

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

2.3.0

特異メソッド

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

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

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

@see c:RDoc::Options#custom_options...

絞り込み条件を変える

2.3.0

インスタンスメソッド

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

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

2.3.0

インスタンスメソッド

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

...ュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

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

@param superclass 追加するクラスの親クラスを RDoc::NormalClass...

...オ
ブジェクトで指定します。

既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。...

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

2.3.0

インスタンスメソッド

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

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

2.3.0

インスタンスメソッド

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

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

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

@see RDoc::Context#add_class...

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

2.3.0

特異メソッド

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

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

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

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

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

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

2.3.0

インスタンスメソッド

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

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

2.3.0

特異メソッド

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

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

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

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

2.3.0

インスタンスメソッド

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

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

2.3.0

特異メソッド

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

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

@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します...

...。
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。

@param options RDoc::Options オブジェクトを指定します。
parent_generator に渡されたものと同...

絞り込み条件を変える

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

2.3.0

特異メソッド

file_name を解析できるパーサのインスタンスを返します。見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。

... RDoc::Parser::Simple のインスタンスを返します。

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

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

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

@param options RDoc::Op...

...tions オブジェクトを指定します。

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

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

2.3.0

インスタンスメソッド

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

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

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

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

@see RDoc::Text#normalize_comment...

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

2.3.0

特異メソッド

自身を初期化します。

...op_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 (9361.0)

2.3.0

特異メソッド

自身を初期化します。

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

2.3.0

特異メソッド

自身を初期化します。

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

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

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

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

@param stats RDoc::Stats オブジ...

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

2.3.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.3.0

特異メソッド

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

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

特異メソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

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

RDoc::CodeObject (9340.0)

2.3.0

クラス

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

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

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

//emlist{
* RDoc::Context
* RDoc::TopLevel
* RDoc::ClassModule
* RDoc::AnonClass
* RDoc::NormalClass
* RDoc::NormalModule
* RD...

...oc::SingleClass
* RDoc::AnyMethod
* RDoc::GhostMethod
* RDoc::MetaMethod
* RDoc::Alias
* RDoc::Attr
* RDoc::Constant
* RDoc::Require
* RDoc::Include
//}...

絞り込み条件を変える

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

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

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

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

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

また、section のシーケンス番号を新しく...

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

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

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

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

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

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

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

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

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

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

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

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

絞り込み条件を変える

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

2.3.0

特異メソッド

自身を初期化します。

...自身を初期化します。

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

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

@param show_hash true を指定した場合、メソッ...

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

2.3.0

インスタンスメソッド

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

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

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

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

2.3.0

インスタンスメソッド

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

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

2.3.0

インスタンスメソッド

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

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

2.3.0

特異メソッド

自身を初期化します。

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

2.3.0

インスタンスメソッド

現在の section を返します。

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

find a module at a higher scope

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

2.3.0

特異メソッド

自身を初期化します。

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

2.3.0

特異メソッド

自身を初期化します。

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

2.3.0

特異メソッド

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

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

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

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

2.3.0

特異メソッド

自身を初期化します。

絞り込み条件を変える

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

2.3.0

特異メソッド

自身を初期化します。

自身を初期化します。

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

RDoc::Options (9286.0)

2.3.0

クラス

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

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

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

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

RDoc のジェネレータでは、RDoc::Options をフックし...

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

...ます。

例:

class RDoc::Generator::Spellcheck
RDoc::RDoc.add_generator self

def self.setup_options rdoc_options
op = rdoc_options.option_parser

op.on('--spell-dictionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_dicti...

RDoc::Markup (9178.0)

2.3.0

クラス

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

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

例:

require 'rdoc/markup/to_html'

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

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

例:

req...

...uire 'rdoc/markup'
require 'rdoc/markup/to_html'

class WikiHtml < RDoc::Markup::ToHtml
# WikiWord のフォントを赤く表示。
def handle_special_WIKIWORD(special)
"<font color=red>" + special.text + "</font>"
end
end

m = RDoc::Markup.new
# { 〜 } までを :STRIK...

...STRIKE のフォーマットを <strike> 〜 </strike> に指定。
wh.add_tag(:STRIKE, "<strike>", "</strike>")

puts "<body>#{wh.convert ARGF.read}</body>"

変換する形式を変更する場合、フォーマッタ(例. RDoc::Markup::ToHtml)
を変更、拡張する必要があります。...

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

2.3.0

インスタンスメソッド

methods で指定した RDoc::AnyMethod、RDoc::Attr の内、 singleton で指定した条件と一致するメソッドすべての可視性を visibility に設定します。

...methods で指定した RDoc::AnyMethod、RDoc::Attr の内、
singleton で指定した条件と一致するメソッドすべての可視性を visibility
に設定します。

@param methods RDoc::AnyMethod、RDoc::Attr オブジェクトの配
列を指定します。

@param vi...

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

2.3.0

インスタンスメソッド

array に 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_require...

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

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

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

RDoc::Parser::RubyTools (9118.0)

2.3.0

モジュール

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

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

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

ライブラリの内部で使用...

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

2.3.0

インスタンスメソッド

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

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

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

@see RDoc::CodeObject#end_d...

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

2.3.0

インスタンスメソッド

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

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

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

@see RDoc::CodeObject#star...

RDoc::Generator (9100.0)

2.3.0

モジュール

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

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

絞り込み条件を変える

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

2.3.0

特異メソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

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

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

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

2.3.0

インスタンスメソッド

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

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

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

RDoc::Markup::Formatter (9070.0)

2.3.0

クラス

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

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

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

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

2.3.0

インスタンスメソッド

name で登録された規則で取得された文字列を start と stop で囲むように指定します。

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

@param start 開始の記号を文字列で指定します。

@param stop 終了の記号を文字列で指定します。

例:

require 'rdoc/markup/to_html...

...'

# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup::ToHtml.new
h.add_tag(:STRIKE, "<strike>", "</strike>")...

RDoc::Parser::Text (9058.0)

2.3.0

モジュール

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

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

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

絞り込み条件を変える

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

2.3.0

インスタンスメソッド

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

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

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

2.3.0

インスタンスメソッド

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

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

RDoc::Context (9052.0)

2.3.0

クラス

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

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

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

2.3.0

インスタンスメソッド

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

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

RDoc::Markdown (9052.0)

2.3.0

クラス

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

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

絞り込み条件を変える

<< 1 2 3 ... > >>

別のキーワード

種類

クラス

モジュール

キーワード

検索結果

先頭5件

RDoc (114055.0)

RDoc::RDoc (63232.0)

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

RDoc::VERSION -> String (63055.0)

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

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

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

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

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

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

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

RDoc::Markup::ToRdoc (27052.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::CodeObject (9340.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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