検索結果

rdoc (38440.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...

...ットに変換するた
めのライブラリです。RDoc によってメソッドやクラスに関するドキュメントを
生成するとき、コメント部を変換するために使われます。

=== ロードマップ

* RDoc で Ruby のソースファイルに対するドキュメ...

...ラリとして使いたければ、RDoc::Markup を参照してください。

=== 概要

インストールすれば、'rdoc' コマンドでドキュメントが生成できます。
(Windows では 'rdoc.bat' です)

$ rdoc [options] [names...]

"rdoc --help" と打てば、最新のオプ...

• 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::Options (21148.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 をフックし...

...まれていた場合、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::Options::Path) do |dictionary|
# RDoc::Options に spell_dictionary...

• RDoc
• RDoc::Options

Gem::Specification#rdoc_options=(options) (12331.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

• インスタンスメソッド

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

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

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

• Gem::Specification

Gem::Specification#rdoc_options -> [String] (12218.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

• インスタンスメソッド

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

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

• Gem::Specification

RDoc::Options#write_options -> object (12133.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_options ファイルに指定した設定を YAML 形式 で保存します。

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

• RDoc::Options

絞り込み条件を変える

RDoc::Options#rdoc_include -> [String] (12101.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

• インスタンスメソッド

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

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

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

• RDoc::Options

rdoc/options (12016.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 コマンドのオプションを解析するためのサブライブラリです。...

• RDoc::Options
• optparse
• pathname

Rake::RDocTask#options=(options) (9230.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 コマンドに渡すオプションのリストをセットします。

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

• Rake::RDocTask

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

• 2.3.0
• 3.0
• 3.2
• 3.3

• インスタンスメソッド

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

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

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

• Rake::RDocTask