【Ruby3.x】Gem::Specification::rdoc_options=()メソッドの使い方

rdoc_options=メソッドは、Rubyのライブラリやアプリケーションをパッケージ化し管理するシステムであるRubyGemsにおいて、Gemの仕様を定義するGem::Specificationオブジェクトに対して、RDoc（Rubyコードからドキュメントを自動生成するツール）を生成する際のオプションを設定するメソッドです。

このメソッドを使用すると、そのGemのドキュメントを作成する際にRDocコマンドに渡される、一連のコマンドラインオプションを文字列の配列として指定できます。例えば、生成されるドキュメントにプライベートメソッドを含めるための-Uオプションや、ドキュメント全体のタイトルを指定する--titleオプションなどを、このメソッドを通じて設定することが可能です。

Gem::Specificationオブジェクトは、Gemの名前、バージョン、説明、依存関係など、そのGemに関するあらゆるメタデータを管理します。その中でrdoc_options=メソッドは、特にそのGemのドキュメントがどのように生成され、どのような情報を含むべきかという詳細な振る舞いを制御するために用いられます。

通常、rake rdocなどのドキュメント生成タスクが実行される際、このメソッドによって設定されたオプションがRDocツールに渡され、最終的に生成されるドキュメントの表示内容や構成に影響を与えます。これにより、開発者はGemの利用者が参照する公式ドキュメントの品質と表現を細かく調整し、Gemの利便性を高めることができます。

Copy
1spec = Gem::Specification.new
2spec.rdoc_options = ["--main", "README.md"]

options

• options: RDocの生成に使用するオプションを指定する配列

Array

このメソッドは、RDocのオプションを設定し、設定されたRDocのオプションの配列を返します。