Doxywizardの使用方法

Doxywizardは、Doxygenの設定と実行をするためのGUIフロントエンドです。

Doxywizardは、設定ファイルを引数として起動することが可能です。

Doxywizardはまず、次のようなメインウィンドウを表示します(実際のウィンドウはOSによって違います)。

メインウィンドウ

メインウィンドウには、設定と実行をするのに必要なステップが示されます。最初のステップは、設定の方法を選択することです。

Wizard: 最も重要な設定項目を素早く構成し、他のオプション項目は初期設定にします。
Expert: すべてのオプション項目を設定するためのボタンです。
Load: ディスクに保存されている設定ファイルを読み込むために押します。

複数のボタンを使って設定できます。たとえば、Wizardボタンでおおまか構成してから、Expertボタンでオプションを設定することができます。

構成を終えたら、それをファイルに保存する必要があります。この第２ステップは、doxygen のためだけでなく、後々同じ設定を使って実行できるようにするという利点があります。

相対パスを使う構成オプションがいくつかあるため、次のステップは doxygen を実行するディレクトリを選ぶことです。このディレクトリは、ソースのルートで、大抵は既に適切なディレクトリが設定されています。

構成ファイルを保存すると、作業ディレクトリが設定され、選択した設定に従って doxygen を実行することができます。開始するには "Start" ボタンを押します。実行を開始しても同じボタンを押せばキャンセルできます。Doxygenが生成する結果はキャプチャされ、ログウィンドウに示されます。Doxygenが実行を終えると、ログはテキストファイルに保存できます。

Wizardダイアログ

ステップ１でWizardボタンを選ぶと、タブが幾つかならんだダイアログが現れます。

Wizardダイアログ: プロジェクトの設定

Projectタブの項目の説明は、画面の通りです。Doxygen が終了すると Destination directory には結果が保存されています。結果は、出力フォーマット毎にサブディレクトリに分けられています。

Wizardダイアログ: 動作モード

Modeタブでは、doxygenがソースをどのように見るかを選びます。初期設定では、ドキュメント付けされた部分だけを見ます。

解析結果をどういうふうに提示させるかを選ぶこともできます。これは、ソースコードの解析方法に影響しません。

Wizardダイアログ: 出力形式

Outputタブでは、出力フォーマットをひとつ以上選べます。HTMLとではオプションが選べます。

Wizardダイアログ: 生成する図

Doxygenは多くの図を生成できます。Diagramsタブでその種類を選択できます。大抵の図には、GraphViz パッケージの dotツールが必要です (MacOSX 用のバイナリーパッケージを使っている場合は、すでにこのツールが含まれています)。

Expertダイアログ

Expertダイアログには、幾つかの項目があり、それぞれ構成ファイルの各セクションに対応しています。各タブで各行は該当セクションの設定オプションに対応しています。

入力ウィジェットの種類は、構成オプションのタイプによって違います。

boolean型のオプション (構成ファイルでYESかNOで答えるオプション) には、チェックボックスを使っています。
固定したセットの値から一つ選択する項目 (OUTPUT_LANGUAGE など) には、コンボボックスを使っています。
一定の範囲の整数型の値から一つ選ぶ項目には、スピンボックスを使っています。
自由に文字列を設定できる項目には、１行のエディットボックスを使っています。
文字列のリストを設定できる項目には、編集用に１行のエディットボックスを用意し、編集した文字列をリストに追加するための`+'ボタンと、リストから選択した文字列を削除するための`-'ボタンを配置しています。`*'ボタンで、リストで選択した文字列をエディットボックスに入力した文字列で置き換えることもできます。
ファイルやフォルダを選択する項目では、ボタンを押して選択ダイアログを起動します。

Expertダイアログのオプション

オプションの意味について補足がほしいときには、ダイアログの右下にある"Help"ボタンを押して、項目をクリックします。ツールチップウィンドウが出ます。

メニューオプション

GUIフロントエンドには、メニューがあり、幾つか有効な項目が並んでいます。

ファイルメニュー

Open...: メインウィンドウの"Load"ボタンと同じく、ディスク上に保存されている設定ファイルを開きます。
Save as..: メインウィンドウの"Save"ボタンと同じく、現在の設定ファイルをディスク上に保存します。
Recent configurations: 最近保存された設定ファイルを素早く選択し、読み込みます。
Set as default...: 現在の設定をデフォルトとして保存し、次回Doxywizardを起動したときすぐ読み込むようにします。これには確認のダイアログが出ます。
Reset...: Doxygenの初期設定を読み込むときに使用します。これには確認のダイアログが出ます。

次のセクションに行く / インデックスに戻る