るりまサーチ (Ruby 2.3.0)

最速Rubyリファレンスマニュアル検索！
88件ヒット [1-88件を表示] （0.057秒）
トップページ > クエリ:rdoc[x] > クエリ:RI[x] > バージョン:2.3.0[x]

別のキーワード

  1. rdoc version
  2. rdoc/context new
  3. rdoc/markdown parse
  4. rdoc attr_modifiers
  5. rdoc class_modifiers

種類

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

  1. rdoc
  2. RDoc::Generator::RI
  3. RDoc::VERSION -> String
  4. RDoc::ATTR_MODIFIERS -> [String]
  5. RDoc::CLASS_MODIFIERS -> [String]

rdoc (115303.0)

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

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

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

RDoc::Generator::RI (63049.0)

ri のためのファイルを生成するためのクラスです。

ri のためのファイルを生成するためのクラスです。

RDoc::VERSION -> String (51349.0)

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

rdoc/generator/ri (36049.0)

ri のためのファイルを生成するためのサブライブラリです。

ri のためのファイルを生成するためのサブライブラリです。

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

RDoc::KNOWN_CLASSES -> {String => String} (27619.0)

Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。

Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。

RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"

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

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

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

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

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

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

作成した HTML ファイルを保存するディレクトリ名を返します。 デフォルトは html です。

作成した HTML ファイルを保存するディレクトリ名を返します。
デフォルトは html です。

RDoc::Parser::Simple#remove_private_comments(comment) -> String (27601.0)

行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返 します。

行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。

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

@return コメントが削除された文字列を返します。

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

RDoc::Stats#print -> () (27301.0)

自身の持つ情報を標準出力に表示します。

自身の持つ情報を標準出力に表示します。

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

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

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

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

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

絞り込み条件を変える

Gem::Server::RDOC_CSS -> String (18652.0)

RDoc のための CSS を表す文字列です。

RDoc のための CSS を表す文字列です。

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

RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。

RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。

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

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

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

rdoc/generator (18583.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
...

Gem::DocManager.update_ri_cache (18400.0)

RDoc 2 がインストールされている場合は RI のキャッシュを更新します。 そうでない場合は何もしません。

RDoc 2 がインストールされている場合は RI のキャッシュを更新します。
そうでない場合は何もしません。

絞り込み条件を変える

rubygems/commands/rdoc_command (18295.0)

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

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

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

Gem::Commands::RdocCommand (18097.0)

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

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

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

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

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

RDoc::Context#unmatched_alias_lists -> {String => RDoc::Alias} (9652.0)

メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。

メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。

RDoc::Markup.new(attribute_manager = nil) -> RDoc::Markup (9622.0)

自身を初期化します。

自身を初期化します。

@param attribute_manager Rdoc::AttributeManager オブジェクトを指
定します。

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Markdown::HTML_ENTITIES -> {String => [Integer]} (9349.0)

HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。

HTML の実体参照のマッピングを表す Hash オブジェクトです。
RDoc::Markdown で使用します。

絞り込み条件を変える

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

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

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

Rake::RDocTask#name -> String (9349.0)

タスクの名前を返します。デフォルトは rdoc です。

タスクの名前を返します。デフォルトは rdoc です。

Rake::RDocTask#template -> String (9349.0)

使用するテンプレートを返します。 デフォルトは RDoc のデフォルトです。

使用するテンプレートを返します。
デフォルトは RDoc のデフォルトです。

Rake::RDocTask#title -> String (9349.0)

RDoc のタイトルを返します。 デフォルト値はありません。

RDoc のタイトルを返します。
デフォルト値はありません。

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

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

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

@see RDoc::CodeObject#parent

絞り込み条件を変える

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

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

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

@see RDoc::CodeObject#parent

RDoc::Markup#content -> String (9319.0)

変換する文字列を返します。

変換する文字列を返します。

rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。

変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる事があります。

@see SM::SimpleMarkup#convert

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

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

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

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

RDoc::CodeObject#comment -> String (9301.0)

自身のコメントを返します。

自身のコメントを返します。

RDoc::Context#name -> String (9301.0)

自身の名前を返します。

自身の名前を返します。

サブクラスによっては、メソッド名やクラス名を意味します。

絞り込み条件を変える

RDoc::Context#visibility -> :public | :protected | :private (9301.0)

自身の可視性を Symbol で返します。

自身の可視性を Symbol で返します。

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

RDoc::Context::VISIBILITIES -> [:public, :protected, :private] (9301.0)

メソッドの可視性を Symbol の配列で返します。

メソッドの可視性を Symbol の配列で返します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

RDoc::Text#expand_tabs(text) -> String (9301.0)

引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな るように置き換えます。

引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな
るように置き換えます。

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

RDoc::Text#flush_left(text) -> String (9301.0)

引数から各行の行頭のスペースを削除します。

引数から各行の行頭のスペースを削除します。

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

RDoc::Text#markup(text) -> String (9301.0)

引数を整形します。

引数を整形します。

include したクラスに self#formatter メソッドが必要です。

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

RDoc::TopLevel#file_absolute_name -> String (9301.0)

自身が管理するファイルに関する絶対パスを文字列で返します。

自身が管理するファイルに関する絶対パスを文字列で返します。

絞り込み条件を変える

RDoc::TopLevel#file_relative_name -> String (9301.0)

自身が管理するファイルに関する相対パスを文字列で返します。

自身が管理するファイルに関する相対パスを文字列で返します。

RDoc::TopLevel#full_name -> String (9301.0)

自身が管理するファイルの名前を返します。

自身が管理するファイルの名前を返します。

Rake::RDocTask#main -> String (9301.0)

メインとして使用されるファイル名を返します。

メインとして使用されるファイル名を返します。

Rake::RDocTask#quote(str) -> String (9301.0)

Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。

Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。

@param str クオートする文字列を指定します。

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

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

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

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

絞り込み条件を変える

NEWS for Ruby 2.0.0 (307.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...

NEWS for Ruby 2.1.0 (163.0)

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

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

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

== 2.0.0 以降の変更

=== 言語仕様の変更

* キーワード引数のデフォルト値が省略可能になりました。これらの「必須キーワード引数」は呼び出し時に明示的に与えなければなりません。

* 整数や小数のリテラルの末尾に'r','i','...

rubygems/commands/install_command (109.0)

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

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

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

Gem::DocManager (97.0)

Gem パッケージの RDoc, RI を生成するためのクラスです。

Gem パッケージの RDoc, RI を生成するためのクラスです。

Gem::DocManager#uninstall_doc (97.0)

RDoc と RI 用のデータを削除します。

RDoc と RI 用のデータを削除します。

絞り込み条件を変える

rubygems/doc_manager (97.0)

Gem パッケージの RDoc, RI を生成するためのクラスを扱うライブラリです。

Gem パッケージの RDoc, RI を生成するためのクラスを扱うライブラリです。

rubygems (73.0)

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

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


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

$ gem help

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

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

例:
...

コマンド (73.0)

コマンド Ruby では以下のコマンドが提供されます。

コマンド
Ruby では以下のコマンドが提供されます。

: erb
埋め込みRuby処理ツール。erb を参照。
: gem
Rubyのパッケージ管理ツール。lib:rubygems#gem_command を参照。
: irb
Ruby の対話インタフェース。irb を参照。
: rake
Ruby の内部 DSL で記述するビルドツール。rake を参照。
: rdoc
Ruby のソースファイルからドキュメントを生成するツール。rdoc を参照。
: ri
RDoc で書かれた Ruby のドキュメントをコマンドラインから閲覧するツール。
: ruby
R...

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

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

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

Powered by Ruby 3.1.2.

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