るりまサーチ (Ruby 2.2.0)

最速Rubyリファレンスマニュアル検索！
302件ヒット [1-100件を表示] （0.090秒）
トップページ > クエリ:r[x] > ライブラリ:rdoc[x] > バージョン:2.2.0[x]

別のキーワード

  1. _builtin to_r
  2. open3 pipeline_r
  3. matrix elements_to_r
  4. fileutils rm_r
  5. fileutils cp_r

種類

クラス

モジュール

キーワード

検索結果

先頭5件

  1. RDoc::Context#add_require(a_require) -> ()
  2. RDoc::Context#requires -> [RDoc::Require]
  3. RDoc::Parser.parsers -> [[Regexp, RDoc::Parser]]
  4. RDoc::Context#record_location(toplevel)
  5. RDoc::Markup#add_word_pair(start, stop, name) -> ()
<< 1 2 3 ... > >>

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

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

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

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

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

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

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

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

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

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

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

Record the file that we happen to find it in

Record the file that we happen to find it in

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

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

...ます。

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

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_word_pair("{", "}", :STRIKE)

h = SM::ToHtml.new
h.add_tag(:S...

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

RDoc::Markup::ToRdoc (27004.0)

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

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

RDoc::Parser::RD (27004.0)

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

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

解析された情報はコメントとして扱われます。

RDoc::RDoc (27004.0)

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

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

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

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

args には rdoc コマンドに渡すのと同様の引数を文字列...
...の配列で指定します。

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

絞り込み条件を変える

RDoc::Require (27004.0)

require されるファイルを表現します。

require されるファイルを表現します。

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

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

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

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

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

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

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

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

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

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

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

RDoc::Markup::LABEL_LIST_RE -> Regexp (18604.0)

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

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

絞り込み条件を変える

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

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

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

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

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

自身を初期化します。

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

RDoc::Parser.parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser (18604.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::Text#strip_hashes(text) -> String (18604.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

RDoc::VERSION -> String (18307.0)

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

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

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

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

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

@see RDoc::CodeObject#document_self...

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

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

...トに含めるか
どうかを設定します。

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

@see RDoc::CodeObject#parent...

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

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

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

@see RDoc::CodeObject#parent...

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

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

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

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

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

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

RDoc::CodeObject#start_doc -> () (18304.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::Context#add_class_or_module(collection, class_type, name, superclass = nil) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (18304.0)

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

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

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

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

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

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

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

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

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

現在の section を返します。

現在の section を返します。

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

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

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

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

Handle sections

Handle sections

絞り込み条件を変える

RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> () (18304.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::Section#parent -> RDoc::Context (18304.0)

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

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

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

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

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

RDoc::Generator::Darkfish::GENERATOR_DIR -> String (18304.0)

このファイルの親ディレクトリへのパスを表す文字列です。

このファイルの親ディレクトリへのパスを表す文字列です。

テンプレートなどのリソースを検索するのに内部で使用します。

RDoc::Generator::Darkfish::VERSION -> &#39;3&#39; (18304.0)

darkfish のバージョンです。

darkfish のバージョンです。

絞り込み条件を変える

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

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

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

RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE -> String (18304.0)

検索インデックスのパスを表す文字列です。

検索インデックスのパスを表す文字列です。

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

RDoc::Options#finish_page_dir (18304.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

使用されていません。

使用されていません。

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

RDoc::Options#promiscuous (18304.0)

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

情報を表示しません。

: 1

通常の表示を行います。

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

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

絞り込み条件を変える

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

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

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

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

@see RDoc::Options#verbosity...

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

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

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

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

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

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

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

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

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

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

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

...マッチするファイルを解析できるパーサとして、
自身を登録します。

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

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

例:

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

絞り込み条件を変える

<< 1 2 3 ... > >>

検索対象のドキュメントは るりまプロジェクト の成果物です。

検索エンジンは Groonga 14.1.2 を使っています。

Groongaは Rroonga 12.1.0 経由で利用しています。

Powered by Ruby 3.1.2.

るりまサーチのリポジトリ は GitHub 上にあります。