Ruby 3.3 リファレンスマニュアル

library rubygems/commands/rdoc_command

[edit]

要約

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                       このコマンドのヘルプを表示します
  -V, --[no-]verbose               表示を詳細にします
  -q, --quiet                      静かに実行します
      --config-file FILE           指定された設定ファイルを使用します
      --backtrace                  バックトレースを表示します
      --debug                      Ruby 自体のデバッグオプションを有効にします
Arguments:
  GEMNAME       ドキュメントを生成する Gem パッケージを指定します。省略すると全ての
                Gem パッケージのドキュメントを生成します。
Summary:
  RDoc/RI ドキュメントを生成します
Defaults:
  --version '>= 0' --rdoc --ri

クラス

Gem::Commands::RdocCommand

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

同時にrequireされるライブラリ

rubygems

RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。

rubygems/builder

Gem::Specification のインスタンスから Gem パッケージを作成するためのライブラリです。

rubygems/command

gem コマンドを扱うためのライブラリです。

rubygems/defaults

RubyGems ライブラリで使用するデフォルト値を返すメソッドを定義したライブラリです。

rubygems/dependency

Gem の依存関係を管理するためのライブラリです。

rubygems/digest/sha2

Digest::SHA256 をラップするためのライブラリです。

rubygems/doc_manager

Gem パッケージの RDoc, RI を生成するためのクラスを扱うライブラリです。

rubygems/exceptions

RubyGems で使用する例外クラスを定義したライブラリです。

rubygems/gem_path_searcher

Gem パッケージに含まれているファイルのうちロード可能なものを検索するためのライブラリです。

rubygems/platform

選択した Gem のインストールを実行できるプラットフォームのリストを扱うライブラリです。

rubygems/remote_fetcher

リモートソースから Gem パッケージや Gem パッケージの情報を取得するためのライブラリです。

rubygems/requirement

Gem パッケージのバージョンに関する必須条件を扱うためのライブラリです。

rubygems/source_index

個々のソースから取得した全ての有効な Gem パッケージをインデックス化するためのライブラリです。

rubygems/source_info_cache

個々の Gem パッケージのインデックス情報のコピーを保存するためのライブラリです。

rubygems/source_info_cache_entry

Gem::SourceInfoCache が持つエントリを表すためのライブラリです。

rubygems/spec_fetcher

リモートリポジトリから Gem のメタデータを取得して更新するためのライブラリです。

rubygems/specification

Gem パッケージのメタデータを扱うためのライブラリです。

rubygems/user_interaction

ユーザとのやりとりを行うライブラリです。

rubygems/version

Gem パッケージのバージョンを扱うためのライブラリです。

rubygems/version_option

Gem::Command の --version, --platform オプションのためのモジュールを定義したライブラリです。