検索結果

rdoc (38374.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_options ファイルを gem に含める事で、rdoc のオプションを保存する
事ができます。また、以下のように --write-options を指定するのが最も簡単
です。

rdoc --markup tomdoc --write-options

この場合、自動的に .rdoc_options フ...

• 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
• ...

rubygems/commands/rdoc_command (12076.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 と ri のライブラリを生成するためのライブラリです。

...RDoc と ri のライブラリを生成するためのライブラリです。

Usage: gem rdoc [args] [options]
Options:
--all インストールされている全ての Gem パッケージの
RDoc/RI ドキュメント...

...を生成します。
--[no-]rdoc RDoc を含めます
--[no-]ri RI を含めます
-v, --version VERSION 指定したバージョンのドキュメントを生成します
Common Options:
-h, --help...

...を有効にします
Arguments:
GEMNAME ドキュメントを生成する Gem パッケージを指定します。省略すると全ての
Gem パッケージのドキュメントを生成します。
Summary:
RDoc/RI ドキュメントを生成しま...

• Gem::Commands::RdocCommand
• rubygems
• rubygems/builder
• rubygems/command
• rubygems/defaults
• rubygems/dependency
• rubygems/digest/sha2
• rubygems/doc_manager
• 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
• ...

Gem::DocManager.load_rdoc (9161.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

• 特異メソッド

Gem の RDoc が使用可能な場合は使用します。 そうでない場合は、標準添付の RDoc を使用します。

...
Gem の RDoc が使用可能な場合は使用します。
そうでない場合は、標準添付の RDoc を使用します。

@raise Gem::DocumentError RDoc が使用できない場合に発生します。...

• Gem::DocManager

Gem::Specification#has_rdoc? -> bool (9145.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 を生成しせん。偽の場合は RDoc を生成します。

@see Gem::Specification#has_rdoc...

• Gem::Specification

Gem::DocManager#run_rdoc(*args) (9135.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 args RDoc に与える引数を指定します。

@raise Gem::FilePermissionError RDoc でドキュメント生成中にファイルにアクセス出来なかった場合に発生します。...

• Gem::DocManager

絞り込み条件を変える

Gem::DocManager#generate_rdoc (9133.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

• インスタンスメソッド

自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。

...自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。...

• Gem::DocManager
• Gem::Specification

Gem::Specification#has_rdoc -> bool (9133.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 を生成しせん。偽の場合は RDoc を生成します。...

• Gem::Specification

Gem::DocManager#setup_rdoc (9129.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 を実行するための準備を行います。

@raise Gem::FilePermissionError RDoc を保存するディレクトリにアクセスする権限がない場合に発生します。...

• Gem::DocManager

Gem::Specification#extra_rdoc_files=(paths) (9123.0)

• 2.1.0
• 2.2.0
• 2.7.0
• 3.1

• インスタンスメソッド

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

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

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

• Gem::Specification