クエリ:- > クエリ:rdoc > バージョン:3.1

261件ヒット [1-100件を表示] （0.084秒）

トップページ >

:rdoc

:3.1

別のキーワード

種類

ライブラリ

クラス

モジュール

オブジェクト

main (1)

キーワード

検索結果

<< 1 2 3 > >>

rdoc (115897.0)

ライブラリ

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

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

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

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

定数

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

RDoc::VERSION -> String (51349.0)

定数

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

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

定数

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

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

定数

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

絞り込み条件を変える

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

定数

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

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

定数

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

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

定数

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

定数

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

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

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

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

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

特異メソッド

自身を初期化します。

自身を初期化します。

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

Gem::Specification#has_rdoc? -> bool (18718.0)

インスタンスメソッド

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

@see Gem::Specification#has_rdoc

Gem::Specification#has_rdoc -> bool (18700.0)

インスタンスメソッド

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

絞り込み条件を変える

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

インスタンスメソッド

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

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

Gem::Server::RDOC_CSS -> String (18652.0)

定数

RDoc のための CSS を表す文字列です。

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

インスタンスメソッド

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

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

インスタンスメソッド

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

rdoc/markdown (18373.0)

ライブラリ

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

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

詳しくは以下を参照してください。

* https://daringfireball.net/projects/markdown/syntax

Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考にプロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。

=== 拡張

以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効にな...

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

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

特異メソッド

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

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

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

@see c:RDoc::Options#custom_options

rubygems/commands/rdoc_command (18247.0)

ライブラリ

RDoc と ri のライブラリを生成するためのライブラリです。

RDoc と ri のライブラリを生成するためのライブラリです。

Usage: gem rdoc [args] [options]
Options:
--all インストールされている全ての Gem パッケージの
RDoc/RI ドキュメントを生成します。
--[no-]rdoc RDoc を含めます
--[no-]ri RI ...

rdoc/parser/c (18163.0)

ライブラリ

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

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

C 言語で記述された拡張ライブラリなどを解析するのに使用します。
rb_define_class や rb_define_method などで定義されたものに
対応する C 言語の関数のコメントを解析します。

例: Array#flatten の場合。rb_ary_flatten のコメントが解析されます。

/*
* Returns a new array that is a one-dimensional flattening of this
* arra...

rdoc/parser/ruby (18109.0)

ライブラリ

Ruby のソースコードを解析するためのサブライブラリです。

Ruby のソースコードを解析するためのサブライブラリです。

拡張子が .rb、.rbw のファイルを解析する事ができます。

=== メタプログラミングされたメソッド

動的に定義されたメソッドをドキュメントに含めたい場合、## でコメントを開始します。

##
# This is a meta-programmed method!

add_my_method :meta_method, :arg1, :arg2

RDoc::Parser::Ruby は上記の :meta_method ようにメソッドの定義を行
うような識別子の後に続くトークンをメソッド名として解釈します。...

絞り込み条件を変える

rdoc/parser/changelog (18073.0)

ライブラリ

ChangeLog ファイルを解析するためのサブライブラリです。

ChangeLog ファイルを解析するためのサブライブラリです。

ChangeLog ファイルを解析して、RDoc::Markup::Document オブジェクト
に変換します。出力される HTML はサイドバーに日ごとに分けられます。

このサブライブラリは主に MRI の ChangeLog を解析するために使われますが、
GNU style の ChangeLog(http://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html
参照)であれば解析できます。

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

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

@param su...

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

@param 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] (10258.0)

特異メソッド

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

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

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

特異メソッド

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

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

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

Rake::RDocTask.new(name = :rdoc) {|pkg| ... } -> Rake::RDocTask (9952.0)

特異メソッド

自身を初期化して RDoc タスクを定義します。

自身を初期化して RDoc タスクを定義します。

ブロックが与えられた場合は、自身をブロックパラメータとして
ブロックを評価します。

@param name タスクの名前を指定します。

絞り込み条件を変える

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

インスタンスメソッド

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

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

特異メソッド

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

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

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

@...

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

特異メソッド

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

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

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

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

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

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

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

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

RDoc::Text#parse(text) -> RDoc::Markup::Document | Array (9670.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 (9658.0)

特異メソッド

自身を初期化します。

自身を初期化します。

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

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

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

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

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

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

特異メソッド

自身を初期化します。

絞り込み条件を変える

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

特異メソッド

自身を初期化します。

自身を初期化します。

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

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

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

特異メソッド

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

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

インスタンスメソッド

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

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

特異メソッド

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

特異メソッド

自身を初期化します。

自身を初期化します。

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

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

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

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

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

特異メソッド

自身を初期化します。

自身を初期化します。

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

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

特異メソッド

自身を初期化します。

自身を初期化します。

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

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

特異メソッド

自身を初期化します。

自身を初期化します。

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

絞り込み条件を変える

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

特異メソッド

自身を初期化します。

自身を初期化します。

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

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

特異メソッド

自身を初期化します。

自身を初期化します。

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

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

特異メソッド

自身を初期化します。

絞り込み条件を変える

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

インスタンスメソッド

現在の section を返します。

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

インスタンスメソッド

find a module at a higher scope

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

特異メソッド

自身を初期化します。

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

特異メソッド

自身を初期化します。

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

特異メソッド

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

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

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

絞り込み条件を変える

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

特異メソッド

自身を初期化します。

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

特異メソッド

自身を初期化します。

自身を初期化します。

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

RDoc::Options::DEPRECATED -> {String -> String} (9601.0)

定数

非推奨のオプションの一覧を返します。

RDoc::Options#dry_run -> bool (9445.0)

インスタンスメソッド

コマンドライン引数の --dry-run オプションを指定していた場合、true を返します。--no-dry-run オプションを指定していた場合、false を返します。

コマンドライン引数の --dry-run オプションを指定していた場合、true を返
します。--no-dry-run オプションを指定していた場合、false を返します。

どちらも指定しなかった場合は false を返します。

RDoc::Options#line_numbers -> bool (9445.0)

インスタンスメソッド

コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返します。

コマンドライン引数の --line-numbers オプションを指定していた場合、true
を返します。--no-line-numbers オプションを指定していた場合、false を返
します。

どちらも指定しなかった場合は false を返します。

絞り込み条件を変える

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

インスタンスメソッド

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::Context#add_to(array, thing) -> () (9427.0)

インスタンスメソッド

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#add_require(a_require) -> () (9415.0)

インスタンスメソッド

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

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

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

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

インスタンスメソッド

以降に解析したコメントを 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#stop_doc -> () (9403.0)

インスタンスメソッド

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

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

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

@see RDoc::CodeObject#start_doc

絞り込み条件を変える

RDoc::Options#include_line_numbers -> bool (9397.0)

インスタンスメソッド

コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --include-line-numbers を指定していた場合に true
を返します。そうでない場合は false を返します。

RDoc::Options#inline_source -> bool (9397.0)

インスタンスメソッド

コマンドライン引数の --inline-source オプションか --one-file を指定していた場合、もしくは --fmt オプションに xml 指定した場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --inline-source オプションか --one-file を指定して
いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま
す。そうでない場合は false を返します。

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

定数

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

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

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

特異メソッド

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

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

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

インスタンスメソッド

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にします。

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま
す。

例えば WikiWord のような、SM::SimpleMarkup#add_word_pair、
SM::SimpleMarkup#add_html でフォーマットできないものに対して使用
します。

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

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

例:

require 'rdoc/markup/simple_markup'
require '...

絞り込み条件を変える

<< 1 2 3 > >>

別のキーワード

種類

ライブラリ

クラス

モジュール

オブジェクト

キーワード

検索結果

先頭5件

rdoc (115897.0)

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

RDoc::VERSION -> String (51349.0)

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

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

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

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

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

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

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

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

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

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

Gem::Specification#has_rdoc? -> bool (18718.0)

Gem::Specification#has_rdoc -> bool (18700.0)

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

Gem::Server::RDOC_CSS -> String (18652.0)

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

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

rdoc/markdown (18373.0)

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

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

rubygems/commands/rdoc_command (18247.0)

rdoc/parser/c (18163.0)

rdoc/parser/ruby (18109.0)

rdoc/parser/changelog (18073.0)

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

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

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

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

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

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

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

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

Rake::RDocTask.new(name = :rdoc) {|pkg| ... } -> Rake::RDocTask (9952.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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