るりまサーチ (Ruby 3.1)

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

別のキーワード

  1. fiddle ref
  2. pointer ref
  3. entity ref
  4. rexml/document ref
  5. _builtin _id2ref

種類

ライブラリ

クラス

キーワード

検索結果

先頭5件

  1. rdoc
  2. rdoc/markup/to_html_crossref
  3. RDoc::Markup::ToHtmlCrossref
  4. RDoc::Markup::ToHtmlCrossref.new(path, context, show_hash) -> RDoc::Markup::ToHtmlCrossref
  5. rdoc/generator

rdoc (115141.0)

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

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

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

rdoc/markup/to_html_crossref (36067.0)

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

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

RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。

RDoc::Markup::ToHtmlCrossref (27049.0)

RDoc 形式のドキュメントを HTML に整形するクラスです。

RDoc 形式のドキュメントを HTML に整形するクラスです。

RDoc::Markup::ToHtmlCrossref.new(path, context, show_hash) -> RDoc::Markup::ToHtmlCrossref (18622.0)

自身を初期化します。

自身を初期化します。

@param path 生成するファイルのパスを文字列で指定します。

@param context RDoc::Context オブジェクトかそのサブクラスのオブジェ
クトを指定します。

@param show_hash true を指定した場合、メソッド名のリンクに # を表示しま
す。false の場合は表示しません。

@raise ArgumentError path に nil を指定した場合に発生します。

rdoc/generator (18565.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/markup (18427.0)

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の
FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う
ツール群の基礎として作られています。RDoc::Markup 自身は何の出力も
行いません。
それらは output_format で後述するクラス群に委ねられています。

=== Markup

基本的には、lib:rdoc#markup と同じです。ただし、rdoc コマンドと
は異なり、Ruby のソースコードのコメント部分ではなく、プレイン...

Module#refine(klass) { ... } -> Module (18319.0)

引数 klass で指定したクラスまたはモジュールだけに対して、ブロックで指定した機能を提供で きるモジュールを定義します。定義した機能は Module#refine を使用せずに直 接 klass に対して変更を行う場合と異なり、限られた範囲のみ有効にできます。 そのため、既存の機能を局所的に修正したい場合などに用いる事ができます。

引数 klass で指定したクラスまたはモジュールだけに対して、ブロックで指定した機能を提供で
きるモジュールを定義します。定義した機能は Module#refine を使用せずに直
接 klass に対して変更を行う場合と異なり、限られた範囲のみ有効にできます。
そのため、既存の機能を局所的に修正したい場合などに用いる事ができます。

refinements 機能の詳細については以下を参照してください。

* https://magazine.rubyist.net/articles/0041/0041-200Special-refinement.html
* https://docs...

rdoc/markdown (18283.0)

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

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

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

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

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

=== 拡張

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

RDoc::RDoc#document(argv) -> nil (18073.0)

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ
レクトリに出力します。

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

@raise RDoc::Error ドキュメントの処理中にエラーがあった場合に発生します。

指定できるオプションについては、lib:rdoc#usage を参照してくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の
doc 以下に出力します。

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

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

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

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

@see c:RDoc::Options#custom_options

絞り込み条件を変える

RDoc::Options (9301.0)

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

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

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


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

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

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

Ruby用語集 (1279.0)

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

...メソッドの
いくつかは未定義にされている。

: リテラル
: literal
プログラム中に直接記述された値のこと。3.14 や "foo" や /\d+/ はリテラル
だが、1 + 2 はリテラルではない。
Math::PI も定数参照なのでリテラルではない。...

正規表現 (1099.0)

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

...= /\A
\d+ # 整数部
(\. # 小数点
\d+ # 小数部
)? # 小数点 + 小数部 はなくともよい
\z/x
float_pat.match("3.14") # => #<MatchData "3.14" 1:".14">
//}

空白を表現したい場合はエスケープをしてください。

//emlist[][ruby]{
/x y/x.match("x y") # => ni...

NEWS for Ruby 3.0.0 (181.0)

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

...r
* Update to Bundler 2.2.3
* CGI
* Update to 0.2.0
* This version is Ractor compatible.
* CSV
* Update to CSV 3.1.9
* Date
* Update to Date 3.1.1
* This version is Ractor compatible.
* Digest
* Update to Digest 3.0.0
* This version is Ractor compatible.
* E...

コマンド (91.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 14.1.2 を使っています。

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

Powered by Ruby 3.1.2.

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