出力の一部としてファイルのSVNからのログを含めるようにDoxygenを構成する方法はありますか?基本的に、コミットを行うときにかなり厳密なログメッセージをSVNに入力します。これらのメッセージには、Doxygen出力内にセクションを含める必要があります。
3 に答える
ビルドサーバー(CruiseControl / Bamboo / TeamCityなど)を使用するのはどうですか?ビルドサーバーはsvnの変更を監視し、ビルドスクリプト(たとえばant)はビルドの一部としてDoxygenを呼び出します。私はこの配置をJavaとC#を組み合わせたビルドで使用しています。ビルドスクリプトは、適切なオプションを指定して「svnlog」を使用して最新のコミットメッセージを取得できます。
これに対する簡単な解決策はわかりませんが、すぐに何かを一緒にハックできると思います。
- まず、 svn2clツールのsvn2html.xslスタイルシートを使用して、SVNログからHTMLファイルを生成できます 。気に入らない場合は 、このブログ投稿で読むことができるように、実際にはそのようなものを書くことは難しくありません。
- 次に、Doxygenの出力を変更して、手順1で生成されたhtmlファイルへのリンクを含めることができます。それについてはよくわかりませんが、カスタマイズに関するdoxygenのマニュアルページから始めるとよいでしょう。
- 第3に、make、シェルスクリプト、またはバッチファイルを使用して、ステップ1と2を自動化するドキュメント用の小さなビルドファイルを作成できます。
あまりエレガントではありませんが、スタートです。
私はこのアイデアが好きですが、確かに、一度に1つのファイルのみをSVNにコミットした場合にのみ機能します。または、doxygenの出力に無関係なコメントが散らばっていますか?
SVNコミットのバッチ更新を使用して実行できると思います。
コミットされたファイルとSVNログファイルを開くことによって行われた変更コメントを表示するSVNコミットを抽出できます。したがって、ログファイルを実行して辞書またはハッシュテーブルを作成することで、変更されたファイルとそのコメントのリストを毎晩作成するWindowsサービスまたはcronジョブを作成できると思います。それが整ったら、cron / winサービスに上記の各ファイルを開いてもらい、説明セクションの最後を検索します。
* @section DESCRIPTION
*
*
*
**/
このセクション内にコメントを配置します。