検索結果

rdoc (115123.0)

• 3.3

• ライブラリ

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

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

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

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

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

• 3.3

• インスタンスメソッド

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

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

• RDoc::AttributeManager
• RDoc::Markup

Gem::DocManager.load_rdoc (27418.0)

• 3.3

• 特異メソッド

Gem の RDoc が使用可能な場合は使用します。 そうでない場合は、標準添付の RDoc を使用します。

Gem の RDoc が使用可能な場合は使用します。
そうでない場合は、標準添付の RDoc を使用します。

@raise Gem::DocumentError RDoc が使用できない場合に発生します。

• Gem::DocManager

Gem::DocManager#run_rdoc(*args) (27388.0)

• 3.3

• インスタンスメソッド

与えられた引数を使用して RDoc を実行します。

与えられた引数を使用して RDoc を実行します。

@param args RDoc に与える引数を指定します。

@raise Gem::FilePermissionError RDoc でドキュメント生成中にファイルにアクセス出来なかった場合に発生します。

• Gem::DocManager

Gem::DocManager#setup_rdoc (27370.0)

• 3.3

• インスタンスメソッド

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

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

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

• Gem::DocManager

絞り込み条件を変える

Gem::DocManager#generate_rdoc (27352.0)

• 3.3

• インスタンスメソッド

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

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

• Gem::DocManager
• Gem::Specification

Gem::DocManager#install_rdoc (27352.0)

• 3.3

• インスタンスメソッド

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

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

• Gem::DocManager

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

• 3.3

• インスタンスメソッド

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

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

• Gem::DocManager

RDoc::Options#coverage_report -> Integer | false (27301.0)

• 3.3

• インスタンスメソッド

コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。

コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。

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

• RDoc::Options

RDoc::Options#coverage_report=(val) (27301.0)

• 3.3

• インスタンスメソッド

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

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

@param val 数値オブジェクトか false を指定します。

• RDoc::Options

絞り込み条件を変える

RDoc::Options#finish_page_dir (27301.0)

• 3.3

• インスタンスメソッド

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

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

• RDoc::Options

RDoc::Options#image_format -> String (27301.0)

• 3.3

• インスタンスメソッド

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

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

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

• RDoc::Options

RDoc::Options#main_page -> String | nil (27301.0)

• 3.3

• インスタンスメソッド

コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。

コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。

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

• RDoc::Options

RDoc::Options#main_page=(val) (27301.0)

• 3.3

• インスタンスメソッド

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

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

@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。

• RDoc::Options

RDoc::Options#page_dir -> Pathname | nil (27301.0)

• 3.3

• インスタンスメソッド

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

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

指定されていない場合は nil を返します。

• RDoc::Options

絞り込み条件を変える

RDoc::Options#page_dir=(val) (27301.0)

• 3.3

• インスタンスメソッド

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

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

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

• RDoc::Options

Gem::DocManager (18049.0)

• 3.3

• クラス

Gem パッケージの RDoc, RI を生成するためのクラスです。

Gem パッケージの RDoc, RI を生成するためのクラスです。

rubygems/doc_manager (18049.0)

• 3.3

• ライブラリ

Gem パッケージの RDoc, RI を生成するためのクラスを扱うライブラリです。

Gem パッケージの RDoc, RI を生成するためのクラスを扱うライブラリです。

• Gem::DocManager
• rubygems
• rubygems/builder
• rubygems/defaults
• rubygems/dependency
• rubygems/digest/sha2
• rubygems/exceptions
• rubygems/gem_path_searcher
• rubygems/platform
• rubygems/remote_fetcher
• rubygems/requirement
• rubygems/source_index
• rubygems/source_info_cache
• rubygems/source_info_cache_entry
• rubygems/spec_fetcher
• rubygems/specification
• rubygems/user_interaction
• rubygems/version

Gem::DocManager.new(spec, rdoc_args = "") -> Gem::DocManager (9640.0)

• 3.3

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param spec ドキュメントを生成する対象の Gem::Specification のインスタンスを指定します。

@param rdoc_args RDoc に渡すオプションを指定します。

• Gem::DocManager
• Gem::Specification

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

• 3.3

• 特異メソッド

自身を初期化します。

自身を初期化します。

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

• RDoc::Markup
• Rdoc::AttributeManager

絞り込み条件を変える

RDoc::Options#warn(message) -> nil (9301.0)

• 3.3

• インスタンスメソッド

--verbose オプションを指定していた場合に message を 標準エラー出力 $stderr に出力します。

--verbose オプションを指定していた場合に message を 標準エラー出力
$stderr に出力します。

• RDoc::Options

Gem::DocManager#uninstall_doc (9049.0)

• 3.3

• インスタンスメソッド

RDoc と RI 用のデータを削除します。

RDoc と RI 用のデータを削除します。

• Gem::DocManager

Gem::DocManager.configured_args -> Array (9049.0)

• 3.3

• 特異メソッド

RDoc に渡す引数を返します。

RDoc に渡す引数を返します。

• Gem::DocManager

Gem::DocManager.configured_args=(args) (9049.0)

• 3.3

• 特異メソッド

RDoc に渡す引数をセットします。

RDoc に渡す引数をセットします。

@param args 文字列の配列か空白区切りの文字列を指定します。

• Gem::DocManager

Gem::DocManager.update_ri_cache (9049.0)

• 3.3

• 特異メソッド

RDoc 2 がインストールされている場合は RI のキャッシュを更新します。 そうでない場合は何もしません。

RDoc 2 がインストールされている場合は RI のキャッシュを更新します。
そうでない場合は何もしません。

• Gem::DocManager

絞り込み条件を変える