クエリ:p > クエリ:rdoc > バージョン:3.3

221件ヒット [1-100件を表示] （0.099秒）

トップページ >

:rdoc

:3.3

別のキーワード

種類

ライブラリ

クラス

モジュール

Gem::InstallUpdateOptions (1)
RDoc::Text (6)

キーワード

検索結果

<< 1 2 3 > >>

rdoc (115123.0)

ライブラリ

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

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

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

rdoc/markup/to_rdoc (54067.0)

ライブラリ

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

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

サブクラス(RDoc::Markup::ToAnsi など)を作成して使います。

RDoc::Parser.parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser (37006.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 オブジェクトを指定します。

Gem::Specification#rdoc_options=(options) (36970.0)

インスタンスメソッド

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

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

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

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

特異メソッド

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

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

絞り込み条件を変える

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

特異メソッド

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

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

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

Gem::DocManager#setup_rdoc (36670.0)

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

RDoc::Options#option_parser -> OptionParser | nil (36601.0)

インスタンスメソッド

コマンドライン引数の解析のための OptionParser オブジェクトを返します。

コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。

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

インスタンスメソッド

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

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

絞り込み条件を変える

RDoc::Parser#parse_files_matching(regexp) -> () (36337.0)

インスタンスメソッド

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

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

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

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

例:

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

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

インスタンスメソッド

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

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

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

RDoc::Options#option_parser=(val) (36301.0)

インスタンスメソッド

コマンドライン引数の解析のための OptionParser オブジェクトを設定します。

コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。

@param val OptionParser オブジェクトを指定します。

rdoc/markup (36283.0)

ライブラリ

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の
FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う
ツール群の基礎として作られています。RDoc::Markup 自身は何の出力も
行いません。
それらは output_format で後述するクラス群に委ねられています。

=== Markup

基本的には、lib:rdoc#markup と同じです。ただし、rdoc コマンドと
は異なり、Ruby のソースコードのコメント部分ではなく、プレイン...

rdoc/parser (36211.0)

ライブラリ

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

以下のメソッドを定義したクラスを作成する事で、新しいパーサクラスを作成
する事ができます。

* #initialize(top_level, file_name, body, options, stats)
* #scan

initialize メソッドは以下の引数を受け取ります。

* top_level RDoc::TopLevel オブジェクトを指定します。
* file_name: file_name ファイル名を文字列で指定します。
* body: ソースコードの内容を文字列で指定します。
*...

絞り込み条件を変える

rdoc/parser/ruby_tools (36097.0)

ライブラリ

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

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

rdoc/markup/to_ansi (36085.0)

ライブラリ

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

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

require 'rdoc/markup/to_ansi'

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

変換した結果は文字列で取得できます。

rdoc/markup/to_bs (36085.0)

ライブラリ

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

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

require 'rdoc/markup/to_bs'

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

変換した結果は文字列で取得できます。実際に効果を確認するためにはページャ
などで出力を確認します。

テキスト中の以下のマークアップ記法をエスケープシーケンスの \b と組み合
わせる事によって見た目を変更します。

* イタリック体(_word_): word にアンダーラインを付けて...

rdoc/markup/to_html (36085.0)

ライブラリ

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

require 'rdoc/markup/to_html'

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

変換した結果は文字列で取得できます。

rdoc/markup/to_html_crossref (36067.0)

ライブラリ

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。

絞り込み条件を変える

RDoc::Markup::ToRdoc (36049.0)

クラス

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

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

rdoc/markup/formatter (36049.0)

ライブラリ

RDoc 形式のドキュメントを整形するためのサブライブラリです。

rdoc/options (36049.0)

ライブラリ

rdoc コマンドのオプションを解析するためのサブライブラリです。

rdoc/top_level (36049.0)

ライブラリ

RDoc::TopLevel を定義するサブライブラリです。

rdoc/parser/c (36037.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/changelog (36019.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
参照)であれば解析できます。

rdoc/parser/ruby (36019.0)

ライブラリ

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

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

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

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

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

##
# This is a meta-programmed method!

add_my_method :meta_method, :arg1, :arg2

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

rdoc/generator/markup (36001.0)

ライブラリ

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

rdoc/parser/markdown (36001.0)

ライブラリ

Markdown 形式で記述されたファイルを解析するためのサブライブラリです。

rdoc/parser/rd (36001.0)

ライブラリ

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

絞り込み条件を変える

rdoc/parser/simple (36001.0)

ライブラリ

ソースコード以外のファイルを解析するためのサブライブラリです。

ソースコード以外のファイルを解析するためのサブライブラリです。

ファイルの内容すべてを 1 つの大きなコメントとして処理します。ただし、ファ
イルの先頭が # で始まっていた場合、先頭行は削除されます。

rdoc/parser/text (36001.0)

ライブラリ

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

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

インスタンスメソッド

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

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

特異メソッド

自身を初期化します。

自身を初期化します。

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

Gem::Specification#extra_rdoc_files=(paths) (27670.0)

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

@see RDoc::Text#normalize_comment

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

特異メソッド

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

RDoc::Options#sanitize_path(path) (27601.0)

インスタンスメソッド

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

Rake::RDocTask#template=(template) (27601.0)

インスタンスメソッド

使用するテンプレートをセットします。

使用するテンプレートをセットします。

@param template 使用するテンプレートを指定します。

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

インスタンスメソッド

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

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

@see Gem::Specification#has_rdoc

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

@see RDoc::CodeObject#start_doc

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

インスタンスメソッド

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

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

インスタンスメソッド

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

Gem::Specification#has_rdoc=(flag) (27352.0)

インスタンスメソッド

RDoc を生成するかどうかをセットします。デフォルトは偽です。

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

定数

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

RDoc::Markup#add_special(pattern, name) -> () (27337.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 '...

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

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

例:

require 'rdoc/markup/...

Gem::InstallUpdateOptions#install_update_defaults_str -> String (27319.0)

インスタンスメソッド

Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。

Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。

デフォルトのオプションは以下の通りです。
--rdoc --no-force --no-test --wrappers

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#parent

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#parent

絞り込み条件を変える

RDoc::Markup#get_line_types -> [Symbol] (27319.0)

インスタンスメソッド

変換する文字列の各行のタイプを Symbol の配列で返します。

変換する文字列の各行のタイプを Symbol の配列で返します。

rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。

@see SM::SimpleMarkup#convert

RDoc::Options#markup -> String (27319.0)

インスタンスメソッド

コマンドライン引数の --markup オプションで指定したフォーマットを返します。

コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。

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

RDoc::Context::Section#inspect -> String (27301.0)

インスタンスメソッド

自身の情報を人間に読みやすい文字列にして返します。

RDoc::Context::TYPES -> ["class", "instance"] (27301.0)

定数

メソッドの種類を文字列の配列で返します。

RDoc::Generator::RI::DESCRIPTION -> String (27301.0)

定数

このジェネレータの説明を表す文字列です。

絞り込み条件を変える

RDoc::Markup::SIMPLE_LIST_RE -> Regexp (27301.0)

定数

リストにマッチする正規表現です。ライブラリの内部で使用します。

リストにマッチする正規表現です。ライブラリの内部で使用します。

ラベルの有無を問わずマッチします。

RDoc::Markup::SPACE -> ?\s (27301.0)

定数

空白文字です。?\s を返します。ライブラリの内部で使用します。

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

RDoc::Options#finish_page_dir (27301.0)

インスタンスメソッド

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

絞り込み条件を変える

RDoc::Options#force_output -> bool (27301.0)

インスタンスメソッド

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

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

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

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

インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --force_output オプションと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。

@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。

RDoc::Options#force_update -> bool (27301.0)

インスタンスメソッド

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

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

RDoc::Options#hyperlink_all -> bool (27301.0)

インスタンスメソッド

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

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

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

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

インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --hyperlink-all オプションと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ
ンと同様の指定を行います。

@param val --hyperlink-all オプションと同じ指定を行う場合は true、そう
でない場合は false を指定します。

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

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

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

インスタンスメソッド

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

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

@param val フォーマットを文字列で指定します。

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

インスタンスメソッド

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

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

--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。

@return 設定されたディレクトリを文字列で返します。

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

インスタンスメソッド

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

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

@param val 設定するディレクトリを文字列で指定します。

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

RDoc::Options#parse(argv) -> () (27301.0)

インスタンスメソッド

コマンドライン引数を解析します。

コマンドライン引数を解析します。

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

また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。

* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合

RDoc::Options#pipe -> bool (27301.0)