検索結果

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

• インスタンスメソッド

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

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

• Gem::Specification

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

• ライブラリ

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

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

$ rdoc [options] [names...]

"rdoc --help" と打てば、最新のオプションに関する情報が得られます。

$ rdoc

このコマンドでカレントディレクトリ以...

...とができます。
例えば、Rdoc そのもののドキュメントを生成する場合は、以下のようにタイプ
します。

$ rdoc --main rdoc/rdoc.rb

RDoc が生成するドキュメントのコメント部で使える様々なマークアップの方法
は以下の markup の...

...。

: --write-options

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


: --verbose

プログラムの解析時に詳細な情報を表示します。

: --version

RDocのバージョンを表示する。

: --webcvs...

• 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::SPECIAL -> [String] (132.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

• 定数

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

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

• RDoc::Options

RDoc::Options#write_options -> object (116.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

• インスタンスメソッド

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

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

• RDoc::Options

rdoc/markdown (42.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

• ライブラリ

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

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

=== 拡張

以降の Markdown の拡張は RDoc のパーサ独自にサポートされている...

...ない機能があります。

Underscores embedded in words are never interpreted as emphasis. (While the
[markdown dingus][dingus] emphasizes in-word underscores, neither the
Markdown syntax nor MarkdownTest mention this behavior.)

また URL を記述すると HTML を出力する際に自動...

...に含める事はできま
せん。この拡張はデフォルトでは無効になっています。

例:

<style type="text/css">
h1 { font-size: 3em }
</style>

==== 定義リスト

RDoc::Markdown#definition_lists を設定する事で定義リストを出力す
る事ができます。...

• RDoc::Markdown
• rdoc
• rdoc/markdown/entities
• rubygems
• rubygems/builder
• rubygems/defaults
• rubygems/dependency
• rubygems/digest/sha2
• rubygems/exceptions
• rubygems/gem_path_searcher
• rubygems/platform
• rubygems/remote_fetcher
• rubygems/requirement
• rubygems/source_index
• rubygems/source_info_cache
• rubygems/source_info_cache_entry
• rubygems/spec_fetcher
• rubygems/specification
• rubygems/user_interaction
• rubygems/version

絞り込み条件を変える

RDoc::Options (24.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

• クラス

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

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

...f

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_options.spell_dictionary = dictiona...

• RDoc
• RDoc::Options