るりまサーチ (Ruby 2.1.0)

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

別のキーワード

  1. io popen
  2. io pipe
  3. io each
  4. io readlines
  5. io each_line

種類

クラス

モジュール

キーワード

検索結果

先頭5件

  1. RDoc::Options#option_parser -> OptionParser | nil
  2. RDoc::Options#write_options -> object
  3. RDoc::CodeObject#section -> RDoc::Context::Section
  4. RDoc::Context#current_section -> RDoc::Context::Section
  5. RDoc::Context#sections -> RDoc::Context::Section

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

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

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

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

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

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

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

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

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

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

現在の section を返します。

現在の section を返します。

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

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

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

絞り込み条件を変える

RDoc::VERSION -> String (18607.0)

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

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

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

Handle sections

Handle sections

RDoc::Generator::Darkfish::VERSION -> '3' (18604.0)

darkfish のバージョンです。

darkfish のバージョンです。

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

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

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

RDoc::Markdown#definition_lists -> bool (18604.0)

定義リストを解釈するかどうかを返します。

定義リストを解釈するかどうかを返します。

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

絞り込み条件を変える

RDoc::Markdown#extension(name, enable) -> () (18604.0)

引数 name で指定した拡張の有効/無効を設定します。

引数 name で指定した拡張の有効/無効を設定します。

@param name 拡張の名前を Symbol で指定します。

@param enable 有効にする場合は true を、無効にする場合は false を指定し
ます。

RDoc::Markdown.extension(name) -> nil (18604.0)

引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定 義します。

引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定
義します。

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

RDoc::Markdown::DEFAULT_EXTENSIONS -> [Symbol] (18604.0)

デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。

デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。

RDoc::Markdown::EXTENSIONS -> [Symbol] (18604.0)

サポートする拡張の一覧を Symbol の配列で返します。

サポートする拡張の一覧を Symbol の配列で返します。

RDoc::Parser.alias_extension(old_ext, new_ext) -> bool (18604.0)

old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登 録します。

old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登
録します。

@param old_ext 拡張子を文字列で指定します。

@param new_ext 拡張子を文字列で指定します。

@return エイリアスが登録された場合は true を返します。old_ext にパーサ
が登録されていない場合、エイリアスが登録されずに false を返しま
す。

絞り込み条件を変える

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

自身を初期化します。

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

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

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

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

また、section のシーケンス番号を新しく...

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

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

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

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

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

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

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

RDoc::Context::Section#==(other) -> bool (9304.0)

自身と other のシーケンス番号を比較した結果を返します。

...自身と other のシーケンス番号を比較した結果を返します。

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

RDoc::Context::Section#comment -> String | nil (9304.0)

section のコメントを返します。

section のコメントを返します。

絞り込み条件を変える

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

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

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

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

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

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

RDoc::Context::Section#sequence -> String (9304.0)

section のシーケンス番号を文字列で返します。

section のシーケンス番号を文字列で返します。

リンクを作成する時に使われます。

RDoc::Context::Section#set_comment(comment) -> () (9304.0)

自身にコメントを設定します。

自身にコメントを設定します。

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

comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。

# ---------------------
# :section: The title
# The body
# ---------------------

RDoc::Context::Section#title -> String | nil (9304.0)

section のタイトルを返します。

section のタイトルを返します。

絞り込み条件を変える

RDoc::Options#all_one_file -> bool (9304.0)

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

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

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

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

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

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

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

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

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

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

RDoc::Options#css -> String (9304.0)

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

RDoc::Options#encoding -> Encoding (9304.0)

コマンドライン引数の --encoding オプションを指定していた場合、指定した エンコーディングに対応する Encoding オブジェクトを返します。

コマンドライン引数の --encoding オプションを指定していた場合、指定した
エンコーディングに対応する Encoding オブジェクトを返します。

指定しなかった場合は Encoding.default_external の値を返します。

RDoc::Options#exclude -> Regexp (9304.0)

コマンドライン引数の --exclude オプションで指定した正規表現を返します。 複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた ものを返します。

コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。

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

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

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

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

RDoc::Options#fileboxes -> bool (9304.0)

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

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

絞り込み条件を変える

RDoc::Options#files -> [String] (9304.0)

解析するファイルの一覧を文字列の配列で返します。

解析するファイルの一覧を文字列の配列で返します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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


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

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

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

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

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

RDoc::Options#quiet -> bool (9304.0)

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

RDoc::Options#show_all -> bool (9304.0)

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

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

RDoc::Options#show_hash -> bool (9304.0)

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

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

RDoc::Options#static_path -> [String] (9304.0)

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し ます。

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。

RDoc::Options#tab_width -> Integer (9304.0)

コマンドライン引数の --tab-width オプションで指定した数値を返します。

コマンドライン引数の --tab-width オプションで指定した数値を返します。

絞り込み条件を変える

RDoc::Options#template -> String (9304.0)

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

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

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

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

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

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

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

RDoc::Options#title -> String | nil (9304.0)

ドキュメントのタイトルを返します。指定されていない場合は nil を返します。

ドキュメントのタイトルを返します。指定されていない場合は nil を返します。

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

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

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

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

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

情報を表示しません。

: 1

通常の表示を行います。

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

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

RDoc::Options#visibility -> :public | :protected | :private (9304.0)

コマンドライン引数の --visibility で指定したオプションを Symbol で返します。

コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。

絞り込み条件を変える

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

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

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

RDoc::Options#webcvs -> String | nil (9304.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

@param options RDoc::Options オブジェクトを指定します。
parent_generator に渡されたものと同...

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

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

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

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

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

RDoc::Parser.parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser (604.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::Parser::C.new(top_level, file_name, body, options, stats) -> RDoc::Parser::C (604.0)

自身を初期化します。

...op_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 (604.0)

自身を初期化します。

...op_level RDoc::TopLevel オブジェクトを指定します。

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

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

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

@param stats RDoc::Stats...

絞り込み条件を変える

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

自身を初期化します。

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

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

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

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

@param stats RDoc::Stats オブジ...

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

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

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

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

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

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

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

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

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

Powered by Ruby 3.1.2.

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