るりまサーチ (Ruby 2.2.0)

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

別のキーワード

  1. string []=
  2. string []
  3. string slice
  4. string slice!
  5. string gsub

種類

ライブラリ

クラス

モジュール

オブジェクト

キーワード

検索結果

先頭5件

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

rdoc (115123.0)

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

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

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

RDoc::VERSION -> String (51352.0)

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

rdoc/markup/to_ansi (18103.0)

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ ブラリです。

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ
ブラリです。

require 'rdoc/markup/to_ansi'

h = RDoc::Markup::ToAnsi.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。

絞り込み条件を変える

rdoc/markup/to_bs (18103.0)

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるサブライブラリです。

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるサブライブラリです。

require 'rdoc/markup/to_bs'

h = RDoc::Markup::ToBs.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。実際に効果を確認するためにはページャ
などで出力を確認します。

テキスト中の以下のマークアップ記法をエスケープシーケンスの \b と組み合
わせる事によって見た目を変更します。

* イタリック体(_word_): word にアンダーラインを付けて...

rdoc/markup/to_html (18103.0)

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

require 'rdoc/markup/to_html'

h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

@see RDoc::CodeObject#parent

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

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

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

@see RDoc::CodeObject#parent

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

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

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

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

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

@see SM::SimpleMarkup#convert

絞り込み条件を変える

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

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

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

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

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

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

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

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

自身の名前を返します。

自身の名前を返します。

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

指定しなかった場合は 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#static_path -> [String] (9304.0)

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

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

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#webcvs -> String | nil (9304.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

引数を整形します。

引数を整形します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

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

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

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

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

RDoc::Markup (9193.0)

RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。

RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。

例:

require 'rdoc/markup/to_html'

h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)

独自のフォーマットを行うようにパーサを拡張する事もできます。


例:

require 'rdoc/markup'
require 'rdoc/markup/to_html'

class WikiHtml < RDoc::Markup::ToHtml
# WikiWord のフォントを赤く表示。
...

絞り込み条件を変える

RDoc::Markup#add_html(tag, name) -> () (9055.0)

tag で指定したタグをフォーマットの対象にします。

tag で指定したタグをフォーマットの対象にします。

@param tag 追加するタグ名を文字列で指定します。大文字、小文字のど
ちらを指定しても同一のものとして扱われます。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_ht...

RDoc::Markup#add_special(pattern, name) -> () (9055.0)

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま す。

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま
す。

例えば WikiWord のような、SM::SimpleMarkup#add_word_pair、
SM::SimpleMarkup#add_html でフォーマットできないものに対して使用
します。

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

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require '...

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

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

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

@param start 開始となる文字列を指定します。

@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

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

例:

require 'rdoc/markup/...

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

ruby 1.8.4 feature (325.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]: 追加され...

絞り込み条件を変える

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

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

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

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

ruby 1.8.2 feature (289.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]: 変更されたクラス／...

Ruby用語集 (271.0)

Ruby用語集 A　B　C　D　E　F　G　I　J　M　N　O　R　S　Y

Ruby用語集
A　B　C　D　E　F　G　I　J　M　N　O　R　S　Y

a　ka　sa　ta　na　ha　ma　ya　ra　wa

=== 記号・数字
: %記法
: % notation
「%」記号で始まる多種多様なリテラル記法の総称。

参照：d:spec/literal#percent

: 0 オリジン
: zero-based
番号が 0 から始まること。

例えば、
Array や Vector、Matrix などの要素の番号、
String における文字の位置、
といったものは 0 オリジンである。

: 1 オリジン
: one-based
...

NEWS for Ruby 2.1.0 (217.0)

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

...をサポート

* rinda
* Rinda::RingServer, Rinda::RingFinger
* マルチキャストソケットをサポート

* rubygems
* 2.2.0 に更新。 Notable new features include:
* Gemfile or gem.deps.rb support including Gem.file.lock (experimental)
* Improved, iterati...

NEWS for Ruby 2.2.0 (163.0)

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

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

それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリス...

絞り込み条件を変える

正規表現 (157.0)

正規表現 * metachar * expansion * char * anychar * string * str * quantifier * capture * grouping * subexp * selector * anchor * cond * option * encoding * comment * free_format_mode * absenceop * list * specialvar * references

正規表現
* metachar
* expansion
* char
* anychar
* string
* str
* quantifier
* capture
* grouping
* subexp
* selector
* anchor
* cond
* option
* encoding
* comment
* free_format_mode
* absenceop
* list
* specialvar
* references


正規表現(regular expression)は文字列のパタ...

main.using(module) -> self (37.0)

引数で指定したモジュールで定義された拡張を有効にします。

引数で指定したモジュールで定義された拡張を有効にします。

有効にした拡張の有効範囲については以下を参照してください。

* https://docs.ruby-lang.org/en/master/syntax/refinements_rdoc.html#label-Scope

@param module 有効にするモジュールを指定します。

//emlist[例][ruby]{
module Sloth
refine String do
def downcase
self
end
end
end

"ABC".downcase # => "abc"...

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

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

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

Powered by Ruby 3.1.2.

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