クエリ:r > クエリ:rdoc > 種類:インスタンスメソッド > バージョン:2.2.0

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

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

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

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

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

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

例:

require 'rdoc/markup/...

RDoc::Context#record_location(toplevel) (36304.0)

2.2.0

インスタンスメソッド

Record the file that we happen to find it in

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

2.2.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 (28303.0)

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

@see RDoc::Text#normalize_comment

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

現在の section を返します。

絞り込み条件を変える

RDoc::Options#generator -> Generator (27604.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。

コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。

指定しなかった場合は、HTML に対応する Generator を返します。

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

2.2.0

インスタンスメソッド

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

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

RDoc::Text#strip_hashes(text) -> String (27604.0)

2.2.0

インスタンスメソッド

引数から各行の行頭の # を削除します。

引数から各行の行頭の # を削除します。

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

RDoc::Text#strip_newlines(text) -> String (27604.0)

2.2.0

インスタンスメソッド

引数から先頭と末尾の改行を削除します。

引数から先頭と末尾の改行を削除します。

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

RDoc::Text#strip_stars(text) -> String (27604.0)

2.2.0

インスタンスメソッド

引数から /* 〜 */ 形式のコメントを削除します。

引数から /* 〜 */ 形式のコメントを削除します。

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

絞り込み条件を変える

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

2.2.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::CodeObject#start_doc -> () (27406.0)

2.2.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::Text#normalize_comment(text) -> String (27376.0)

2.2.0

インスタンスメソッド

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

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

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

RDoc::CodeObject#document_children=(val) (27340.0)

2.2.0

インスタンスメソッド

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

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

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

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

@see RDoc::CodeObject#document_self=,
RDoc::CodeObject#remove_classes_and_modules

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

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

例:

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

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

2.2.0

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

@see RDoc::CodeObject#parent

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

2.2.0

インスタンスメソッド

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

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

@see RDoc::CodeObject#parent

絞り込み条件を変える

RDoc::Options#extra_accessor_flags -> {String => String} (27322.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサがキー、アクセサの種類が値のハッシュを返します。

コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。

値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。

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

2.2.0

インスタンスメソッド

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

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

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

RDoc::Options#verbosity=(val) (27322.0)

2.2.0

インスタンスメソッド

プログラムの解析時に表示する情報の詳細さを数値で指定します。

プログラムの解析時に表示する情報の詳細さを数値で指定します。

@param val 何も表示しない場合は 0、通常の表示を行う場合は 1、詳細な表示
を行う場合は 2 を指定します。

@see RDoc::Options#verbosity

RDoc::Context#set_current_section(title, comment) -> () (27304.0)

2.2.0

インスタンスメソッド

Handle sections

RDoc::Generator::Darkfish#generate -> () (27304.0)

2.2.0

インスタンスメソッド

解析した情報を HTML ファイルや検索用のインデックスに出力します。

絞り込み条件を変える

RDoc::Generator::RI#generate -> () (27304.0)

2.2.0

インスタンスメソッド

解析した情報を ri コマンドから読めるようにファイルに出力します。

RDoc::Markdown#break_on_newline -> bool (27304.0)

2.2.0

インスタンスメソッド

改行を保持した状態で出力するかどうかを返します。

改行を保持した状態で出力するかどうかを返します。

デフォルトでは false を返します。

RDoc::Markdown#break_on_newline=(val) (27304.0)

2.2.0

インスタンスメソッド

改行を保持した状態で出力するかどうかを設定します。

RDoc::Markup#convert(str, formatter) -> object | "" (27304.0)

2.2.0

インスタンスメソッド

str で指定された文字列を formatter に変換させます。

str で指定された文字列を formatter に変換させます。

@param str 変換する文字列を指定します。

@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。

変換結果は formatter によって文字列や配列を返します。

RDoc::Markup::Formatter#convert(content) -> () (27304.0)

2.2.0

インスタンスメソッド

content で指定された文字列を変換します。

content で指定された文字列を変換します。

@param content 変換する文字列を指定します。

絞り込み条件を変える

RDoc::Options#charset -> String (27304.0)

2.2.0

インスタンスメソッド

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

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

指定しなかった場合は、$KCODE に応じた値になります。

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

RDoc::Options#diagram -> bool (27304.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --diagram オプションを指定していた場合、true を返します。そうでない場合は false を返します。

コマンドライン引数の --diagram オプションを指定していた場合、true を返
します。そうでない場合は false を返します。

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

2.2.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

RDoc::Options#dry_run=(val) (27304.0)

2.2.0

インスタンスメソッド

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

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

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

RDoc::Options#extra_accessors -> Regexp | nil (27304.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべてにマッチする正規表現オブジェクトを返します。

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。

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

RDoc::Options#finish_page_dir (27304.0)

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

RDoc::Options#formatter -> nil (27304.0)

2.2.0

インスタンスメソッド

使用されていません。常に nil を返します。

RDoc::Options#formatter=(val) (27304.0)

2.2.0

インスタンスメソッド

使用されていません。

RDoc::Options#generator=(val) (27304.0)

2.2.0

インスタンスメソッド

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

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

@param val 設定する Generator を指定します。

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

2.2.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

RDoc::Options#line_numbers=(val) (27304.0)

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

RDoc::Options#merge -> true | nil (27304.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --merge オプションを指定していた場合、true を返します。そうでない場合は nil を返します。

コマンドライン引数の --merge オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。

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

2.2.0

インスタンスメソッド

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

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

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

RDoc::Options#promiscuous (27304.0)

2.2.0

インスタンスメソッド

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

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

絞り込み条件を変える

RDoc::Options#root -> Pathname (27304.0)

2.2.0

インスタンスメソッド

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

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

指定されていない場合はカレントディレクトリを返します。

RDoc::Options#root=(val) (27304.0)

2.2.0

インスタンスメソッド

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

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

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

RDoc::Options#template_dir -> String | nil (27304.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --template オプションで指定したテンプレートに対応するディレクトリを返します。

コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。

オプションの解析前は nil を返します。

RDoc::Options#template_dir=(val) (27304.0)

2.2.0

インスタンスメソッド

コマンドライン引数の --template オプションで指定したテンプレートに対応するディレクトリを設定します。

コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。

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

RDoc::Options#verbosity -> 0 | 1 | 2 (27304.0)

2.2.0

インスタンスメソッド

プログラムの解析時に表示する情報の詳細さを数値で返します。

プログラムの解析時に表示する情報の詳細さを数値で返します。

以下の値を指定する事ができます。

: 0(--quiet オプションを指定した場合)

情報を表示しません。

: 1

通常の表示を行います。

: 2(--verbose オプションを指定した場合)

詳細な情報を表示します。

絞り込み条件を変える

<< 1 2 3 > >>

別のキーワード

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

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

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

Rake::RDocTask#rdoc_files=(filelist) (45655.0)

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

Rake::RDocTask#rdoc_dir=(dir) (45607.0)

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

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

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

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

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

Gem::DocManager#setup_rdoc (36673.0)

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

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

Gem::DocManager#generate_rdoc (36655.0)

Gem::DocManager#install_rdoc (36655.0)

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

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

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

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

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

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

RDoc::Context#record_location(toplevel) (36304.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Options#generator -> Generator (27604.0)

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

RDoc::Text#strip_hashes(text) -> String (27604.0)

RDoc::Text#strip_newlines(text) -> String (27604.0)

RDoc::Text#strip_stars(text) -> String (27604.0)

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

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

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

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

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

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

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

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

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

RDoc::CodeObject#document_children=(val) (27340.0)

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

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

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

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

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

RDoc::Options#extra_accessor_flags -> {String => String} (27322.0)

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

RDoc::Options#verbosity=(val) (27322.0)

RDoc::Context#set_current_section(title, comment) -> () (27304.0)

RDoc::Generator::Darkfish#generate -> () (27304.0)

RDoc::Generator::RI#generate -> () (27304.0)

RDoc::Markdown#break_on_newline -> bool (27304.0)

RDoc::Markdown#break_on_newline=(val) (27304.0)

RDoc::Markup#convert(str, formatter) -> object | "" (27304.0)

RDoc::Markup::Formatter#convert(content) -> () (27304.0)

RDoc::Options#charset -> String (27304.0)

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

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

RDoc::Options#diagram -> bool (27304.0)

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

RDoc::Options#dry_run=(val) (27304.0)

RDoc::Options#extra_accessors -> Regexp | nil (27304.0)

RDoc::Options#finish_page_dir (27304.0)