検索結果

rdoc (38386.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

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

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

このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby...

...メントを出
力します(現在は HTML しか出力できませんが、この部分は取り替え可能にでき
ています)。Markup とはプレーンテキストを様々なフォーマットに変換するた
めのライブラリです。RDoc によってメソッドやクラスに関...

...使われます。

=== ロードマップ

* RDoc で Ruby のソースファイルに対するドキュメントを生成したければ、まずこの文章を読みましょう。
* Cで書かれた拡張ライブラリを含めたければ、rdoc/parser/c を参照してください。
* コ...

• RDoc
• RDoc::Error
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/generator
• rdoc/generator/darkfish
• rdoc/generator/json_index
• rdoc/generator/markup
• rdoc/generator/ri
• rdoc/ghost_method
• rdoc/include
• rdoc/known_classes
• rdoc/markdown
• ...

rdoc/markup/to_html_crossref (18022.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

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

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

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

• RDoc::Markup::ToHtmlCrossref
• rdoc/markup
• rdoc/markup/formatter
• rdoc/markup/to_html

RDoc::Markup::ToHtmlCrossref (15016.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• クラス

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

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

rdoc/generator (12188.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

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 のオプションの追加

rdoc ではオプションの処理の前に RDoc::Options は各ジェネ
レータの #setup_...

...options メソッドを実行します。ジェネレータは 第一引数で
渡される RDoc::Options#option_parser に対して rdoc コマンドのオプ
ションを追加できます。lib:rdoc/options#custom_options の例と
OptionParser も併せて参照してください。

=== ジェ...

• RDoc::Generator
• rdoc/generator/darkfish
• rdoc/generator/json_index
• rdoc/generator/markup
• rdoc/generator/ri

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

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

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

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

指定できるオプションについては、lib:rdoc#usage を参照し...

• RDoc::RDoc

絞り込み条件を変える

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• 特異メソッド

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

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

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

@see c:RDoc::Options#custom_options...

• RDoc::RDoc

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• 特異メソッド

自身を初期化します。

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

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

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

@param show_hash true を指定した場合、メソッド...

...名のリンクに # を表示しま
す。false の場合は表示しません。

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

• RDoc::Context
• RDoc::Markup::ToHtmlCrossref

RDoc::Options (9100.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• クラス

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

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

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


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

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

...を指定できます。

Object::ARGV に --format が含まれていた場合、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
• RDoc::Options

正規表現 (396.0)

• 2.6.0
• 2.7.0
• 3.0
• 3.1

• 文書

正規表現 * 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 ex...

...のどの場所であるかを知ることができます。

//emlist[][ruby]{
/pat/
%r{pat}
//}

などの正規表現リテラルや Regexp.new などで正規表現
オブジェクトを得ることができます。


===[a:metachar] メタ文字列とリテラル、メタ文字とエスケー...

...、オライリー・ジャパン（2008） https://www.oreilly.co.jp/books/9784873113593/
* Onigmoのドキュメント：https://github.com/k-takata/Onigmo/blob/master/doc/RE.ja
* Ruby の tarball に含まれている doc/regexp.rdoc：https://github.com/ruby/ruby/blob/master/doc/regexp.rdoc...

• Encoding::CompatibilityError
• MatchData
• Symbol
• spec/m17n