クエリ:IO > バージョン:2.2.0 > ライブラリ:rdoc

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

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

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

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

絞り込み条件を変える

RDoc::Context::Section (18004.0)

2.2.0

クラス

section に関する情報を保持するクラスです。

section に関する情報を保持するクラスです。

ドキュメント中で以下のように記述した情報を保持しています。

# :section: The title
# The body

RDoc::Options (18004.0)

2.2.0

クラス

rdoc コマンドのオプションを解析するためのクラスです。

...rdoc コマンドのオプションを解析するためのクラスです。

それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。

===[a:custom_options] カスタムオプション

RDoc のジェネレータでは、RDoc::Options をフックし...

...まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要があります。rdoc --help を実行する...

...ます。

例:

class RDoc::Generator::Spellcheck
RDoc::RDoc.add_generator self

def self.setup_options rdoc_options
op = rdoc_options.option_parser

op.on('--spell-dictionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_dicti...

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

2.2.0

特異メソッド

自身を初期化します。

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

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

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

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

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

2.2.0

インスタンスメソッド

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

RDoc::Options#encoding=(val) (9004.0)

2.2.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

RDoc::Options#exclude=(val) (9004.0)

2.2.0

インスタンスメソッド

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

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

@param val 設定するパターンを Regexp オブジェクトで指定します。

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

RDoc::Options#finish_page_dir (9004.0)

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

使用されていません。

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

RDoc::Options#inline_source -> bool (9004.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 (9004.0)

2.2.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

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

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

2.2.0

インスタンスメソッド

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

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

RDoc::Options#pipe=(val) (9004.0)

2.2.0

インスタンスメソッド

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

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

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

RDoc::Options#promiscuous (9004.0)

2.2.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

RDoc::Options#show_all=(val) (9004.0)

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

RDoc::Options#static_path=(vals) (9004.0)

2.2.0

インスタンスメソッド

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

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

@param vals パスを文字列の配列で指定します。

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

絞り込み条件を変える

RDoc::Options#title=(string) (9004.0)

2.2.0

インスタンスメソッド

ドキュメントのタイトルがまだ設定されていない場合に string で指定した文字列に設定します。

ドキュメントのタイトルがまだ設定されていない場合に string で指定した文
字列に設定します。

コマンドライン引数で既に --title オプションが指定されていた場合には、そ
ちらを優先します。

@param string 設定するタイトルを文字列で指定します。

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

2.2.0

インスタンスメソッド

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

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

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

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

情報を表示しません。

: 1

通常の表示を行います。

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

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

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

2.2.0

インスタンスメソッド

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

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

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

@see RDoc::Options#verbosity...

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

2.2.0

インスタンスメソッド

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

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

RDoc::Options#visibility=(val) (9004.0)

2.2.0

インスタンスメソッド

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

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

@param val :public、:protected、:private のいずれかを指定します。

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

定数

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

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

2.2.0

定数

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

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

RDoc::Markdown.new(extensions = DEFAULT_EXTENSIONS, debug = false) (604.0)

2.2.0

特異メソッド

引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブジェクトを初期化します。

...引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブ
ジェクトを初期化します。

@param extensions 有効にする拡張を Symbol の配列で指定します。

@param debug デバッグを有効にするかどうかを指定します。...

絞り込み条件を変える

<< 1 2 > >>

別のキーワード

種類

クラス

モジュール

キーワード

検索結果

先頭5件

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

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

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

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

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

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

RDoc::VERSION -> String (18307.0)

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

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

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

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

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

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

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

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

RDoc::Markdown#extension?(name) (18304.0)

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

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

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

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

RDoc::Context::Section (18004.0)

RDoc::Options (18004.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Options#encoding=(val) (9004.0)

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

RDoc::Options#exclude=(val) (9004.0)

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

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

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

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

RDoc::Options#finish_page_dir (9004.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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