Doxygen実行用API

Question

ソースコードをコードリポジトリに挿入するたびにDoxygenの実行を自動化したいと考えました。私のJavaコードで実行を開始するために使用できるdoxygen用のapi/interfaceはありますか？

Answer 1

Doxygen自体はコマンドラインコマンドを実行することで起動されるため、チェックイン時にコマンドを実行する方法が必要です。デベロッパー環境やSCCツールについては何も言わないので、具体的な答えを出すのは難しいです。

これを行う通常の方法は、Continuous Integrationを実行するビルドサーバーを使用することです。つまり、コードをチェックインすると、ビルドサーバーはチェックインを認識し、新しいコードを取得してビルドを実行します（この場合、Doxygenドキュメント）。 many tools availableがあり、PCを自動化してビルドサーバーを作ります。どちらを使用するかは、使用しているOSとソース管理パッケージのようなものによって決まります。 （専用のビルドサーバーを持っていない/望んでいない場合は、バックグラウンドで自分のPCでこのようなツールを実行することもできます）。

チェックイン時に自分のPCでビルドを実行したい場合は、ソース管理ソフトウェアを調べて、チェックインが可能かどうかを調べることができます。 SCCの中には、特定のイベントに対してスクリプトやコマンドを実行する機能を提供するものがあるため、コマンドを実行することが可能な場合があります。

最後に、多くの人がDoxygenを実行する開発環境内にツール/マクロをセットアップした後、手動で実行します。 Visual Studioでは、チェックインとDoxygenの両方を実行するマクロを単一のキー入力から作成することもできます。

Answer 2

doxygenでさらに制御したい場合は、xmlファイルも生成し、xml出力ファイルを解析してすべての制約をチェックするプログラムを作成し、constaintに違反した場合はビルドを停止する必要があります。

このテクニックにはいくつかの開発努力が必要ですが、これはdoxygenで欲しいことを知っている唯一の方法です。