バージョン:2.1.0 > クエリ:RDoc > クエリ:Options

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

トップページ >

:2.1.0

:RDoc

:Options

別のキーワード

種類

ライブラリ

クラス

モジュール

Gem::InstallUpdateOptions (1)

キーワード

検索結果

RDoc::Options (63445.0)

2.1.0

クラス

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

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

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

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

RDoc のジェネレータでは、RDoc::Options をフックして独自の
オプションを指定できます。

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

rdoc/options (36049.0)

2.1.0

ライブラリ

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

rdoc (19321.0)

2.1.0

ライブラリ

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

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

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

rdoc/generator (18655.0)

2.1.0

ライブラリ

RDoc が解析したソースコードを RDoc::CodeObject のツリーからその他の形式に出力するためのサブライブラリです。

RDoc が解析したソースコードを RDoc::CodeObject のツリーから
その他の形式に出力するためのサブライブラリです。

RDoc には HTML 向けのジェネレータの
RDoc::Generator::Darkfish と ri 向けのジェネレータの
RDoc::Generator::RI が付属しています。

=== ジェネレータの登録

RDoc::RDoc.add_generator を呼び出す事でジェネレータの登録が行えます。

class My::Awesome::Generator
RDoc::RDoc.add_generator self
end
...

絞り込み条件を変える

rdoc/markdown (18301.0)

2.1.0

ライブラリ

Markdown 形式で記述されたドキュメントを rdoc 上で解析するためのサブライブラリです。

Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
サブライブラリです。

詳しくは以下を参照してください。

* https://daringfireball.net/projects/markdown/syntax

Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考にプロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。

=== 拡張

以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効にな...

rdoc/parser (18283.0)

2.1.0

ライブラリ

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

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

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

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

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

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

rake/rdoctask (18253.0)

2.1.0

ライブラリ

ドキュメントを作成するためのタスクを定義します。

ドキュメントを作成するためのタスクを定義します。

以下のタスクを定義します。

: rdoc
RDoc を作成します。
: clobber_rdoc
生成された RDoc のファイルを削除します。
このタスクは clobber タスクにも追加されます。
: rerdoc
既に存在する RDoc が古くなくても RDoc を作成します。

例:
Rake::RDocTask.new do |rd|
rd.main = "README.rdoc"
rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
...

rubygems/commands/rdoc_command (18211.0)

2.1.0

ライブラリ

RDoc と ri のライブラリを生成するためのライブラリです。

RDoc と ri のライブラリを生成するためのライブラリです。

Usage: gem rdoc [args] [options]
Options:
--all インストールされている全ての Gem パッケージの
RDoc/RI ドキュメントを生成します。
--[no-]rdoc RDoc を含めます
--[no-]ri RI ...

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

2.1.0

定数

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

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

絞り込み条件を変える

rdoc/generator/json_index (18073.0)

2.1.0

ライブラリ

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデックスを生成するサブライブラリです。

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するサブライブラリです。

This generator is derived from sdoc by Vladimir Kolesnikov and
contains verbatim code written by him.

このジェネレータは HTML ジェネレータと一緒に使うために設計されています。:

class RDoc::Generator::Darkfish
def initialize options
# ...
@base_dir = Pa...

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

2.1.0

特異メソッド

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

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

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

@see c:RDoc::Options#custom_options

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

2.1.0

インスタンスメソッド

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

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

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

@see RDoc::Options#verbosity

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

絞り込み条件を変える

RDoc::Options#finish_page_dir (18001.0)

2.1.0

インスタンスメソッド

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

使用されていません。

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

RDoc::Options#promiscuous (18001.0)

2.1.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

2.1.0

インスタンスメソッド

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

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

2.1.0

インスタンスメソッド

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

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

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

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

絞り込み条件を変える

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

2.1.0

インスタンスメソッド

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

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

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

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

情報を表示しません。

: 1

通常の表示を行います。

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

2.1.0

インスタンスメソッド

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

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

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

絞り込み条件を変える

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

2.1.0

定数

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

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

2.1.0

特異メソッド

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

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

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

@...

RDoc::Parser.parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser (9745.0)

2.1.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 オブジェクトを指定します。

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

2.1.0

インスタンスメソッド

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

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

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

絞り込み条件を変える

RDoc::Parser::C.new(top_level, file_name, body, options, stats) -> RDoc::Parser::C (9697.0)

2.1.0

特異メソッド

自身を初期化します。

自身を初期化します。

@param top_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 (9697.0)

2.1.0

特異メソッド

自身を初期化します。

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

2.1.0

特異メソッド

自身を初期化します。

自身を初期化します。

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

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

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

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

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

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

2.1.0

インスタンスメソッド

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

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

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

NEWS for Ruby 2.0.0 (181.0)

2.1.0

文書

NEWS for Ruby 2.0.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。

NEWS for Ruby 2.0.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。

それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリストは ChangeLog ファイルか bugs.ruby-lang.org の issue を参照してください。

== 1.9.3 以降の変更

=== 言語仕様の変更

* キーワード引数を追加しました
* %i, %I をシンボルの配列作成のために追加しました。(%w, %W に似ています)
* デフォルトのソースエンコーディングを US-ASCI...

絞り込み条件を変える

rubygems/commands/install_command (163.0)

2.1.0

ライブラリ

Gem パッケージをローカルリポジトリにインストールするためのライブラリです。

Gem パッケージをローカルリポジトリにインストールするためのライブラリです。

Usage: gem install GEMNAME [GEMNAME ...] [options] -- --build-flags [options]
Options:
--platform PLATFORM 指定されたプラットフォームの Gem パッケージをインストールします
-v, --version VERSION 指定されたバージョンの Gem パッケージをインストールします
Install/Update Op...

ruby 1.8.4 feature (91.0)

2.1.0

文書

ruby 1.8.4 feature ruby 1.8.4 での ruby 1.8.3 からの変更点です。

ruby 1.8.4 feature
ruby 1.8.4 での ruby 1.8.3 からの変更点です。

掲載方針

*バグ修正の影響も含めて動作が変わるものを収録する。
*単にバグを直しただけのものは収録しない。
*ライブラリへの単なる定数の追加は収録しない。

以下は各変更点に付けるべきタグです。

記号について(特に重要なものは大文字(主観))

# * カテゴリ
# * [ruby]: ruby インタプリタの変更
# * [api]: 拡張ライブラリ API
# * [lib]: ライブラリ
* レベル
* [bug]: バグ修正
* [new]: 追加され...

rubygems (73.0)

2.1.0

ライブラリ

RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。

RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。

===[a:gem_command] gem コマンドの使い方

$ gem help

RubyGems は Ruby のための高機能なパッケージ管理ツールです。
これはより多くの情報へのポインタを含んでいる基本的なヘルプメッセージです。

使用方法:
gem -h/--help
gem -v/--version
gem command [arguments...] [options...]

例:
...

rubygems/commands/server_command (73.0)

2.1.0

ライブラリ

ローカルにインストールされている Gem パッケージとそのドキュメントを HTTP サーバに載せて公開するためのライブラリです。

ローカルにインストールされている Gem パッケージとそのドキュメントを HTTP サーバに
載せて公開するためのライブラリです。

Usage: gem server [options]
Options:
-p, --port=PORT port to listen on
-d, --dir=GEMDIR directory from which to serve gems
--[no-]daemon run as a daemon
...

ruby 1.8.2 feature (55.0)

2.1.0

文書

ruby 1.8.2 feature ruby 1.8.2 での ruby 1.8.1 からの変更点です。

ruby 1.8.2 feature
ruby 1.8.2 での ruby 1.8.1 からの変更点です。

掲載方針

*バグ修正の影響も含めて動作が変わるものを収録する。
*単にバグを直しただけのものは収録しない。
*ライブラリへの単なる定数の追加は収録しない。

以下は各変更点に付けるべきタグです。

*カテゴリ
* [ruby]: ruby インタプリタの変更
* [api]: 拡張ライブラリ API
* [lib]: ライブラリ
*レベル
* [bug]: バグ修正
* [new]: 追加されたクラス／メソッドなど
* [compat]: 変更されたクラス／...

絞り込み条件を変える

別のキーワード

種類

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

RDoc::Options (63445.0)

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

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

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

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

rdoc/options (36049.0)

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

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

rdoc (19321.0)

rdoc/generator (18655.0)

rdoc/markdown (18301.0)

rdoc/parser (18283.0)

rake/rdoctask (18253.0)

rubygems/commands/rdoc_command (18211.0)

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

rdoc/generator/json_index (18073.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Options#finish_page_dir (18001.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Options#promiscuous (18001.0)

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

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

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

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

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

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

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