SVNリポジトリにdoxygenドキュメントを添付してください

Question

私のプロジェクトのDoxygen HTMLドキュメントをSVNリポジトリに組み込んでコミットすることをお勧めしますか？

Answer 1

ドキュメントが生成されるため、いいえと言いがちです。

一般的に、（ドキュメントを含むバージョンをリリースする場合など）有用な場合がありますが、生成されたコンテンツはVCSから保護する必要があります。

ドキュメントをバージョン管理するのは、コミットするたびに新しくドキュメントを生成した場合にのみ意味があります（私の経験では通常は行われません）。そうしないと、生成されたドキュメントが実際のコードと一致しない場合があります。

doxyfile.dox（世代設定を保存する場所）を代わりに入力してください。設定を配布する場合は、プロジェクトのインストール中にドキュメントをオンザフライで生成することができます。