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

Doxywizard を起動する際、引数として既存の設定ファイルを指定できます。指定しない場合は、デフォルト設定が開始点として使用されます。

Doxywizard を起動すると、メインウィンドウが表示されます (実際の外観は使用しているプラットフォームによって異なります)。

メインウィンドウ

ユーザーインターフェースは以下のセクションで構成されています。

Doxygen を実行する作業ディレクトリを指定します。

Select... ボタンを使用してディレクトリを選択できます。Doxywizard が設定ファイルと共に起動された場合、または開くコマンド (参照: ファイルメニュー) を使用してファイルが読み込まれた場合、その設定ファイルのディレクトリが作業ディレクトリとして使用されます。

ウィザードタブやエキスパートタブを使って Doxygen を設定します...

ウィザードタブ: このタブでは、最も重要な設定を迅速に構成し、残りのオプションはデフォルトのままにすることができます。
エキスパートタブ: このタブでは、設定オプションの全セットにアクセスできます。
実行タブ: このタブでは、Doxygen を実行し、使用された設定を表示できます。

これらのタブ間の切り替えは可能です。たとえば、ウィザードタブから開始し、エキスパートタブに切り替えて一部の設定を微調整することができます。

Doxygen の設定後、設定をファイルとしてディスクに保存する必要があります (参照: ファイルメニュー)。これにより、Doxygen はその設定を使用でき、後で同じ設定で Doxygen を再度実行できるようになります。

一部の設定オプションでは相対パスを使用する可能性があるため、それらのパスのルートとなる作業ディレクトリを選択するようにしてください。これは多くの場合、ソースツリーのルートであり、設定ファイルがこの場所にも保存されていれば、通常は正しく入力されます。

設定ファイルが保存され、作業ディレクトリが設定されたら、選択した設定に基づいて Doxygen を実行できます。実行タブに切り替えて「Doxygen の実行」ボタンをクリックするか、設定メニューで「Doxygen の実行」項目を選択して実行します。

Doxygen の実行中は、同じボタンをもう一度クリックするとキャンセルできます。Doxygen によって生成された出力は、「Doxygen によって生成された出力」ペインにキャプチャされて表示されます。Doxygen の終了後、ログをテキストファイルとして保存できます。

ウィザードタブ

ウィザードタブは2つのペインに分かれています。

左ペイン: Doxygen を簡単にセットアップするための主要なトピックが表示されます。トピックをクリックすると、対応する設定が右ペインに表示されます。
右ペイン: ウィザードの設定ペインです。このペインには、選択したトピックに利用可能な設定が表示されます。

ウィザードは Doxygen を迅速にセットアップする可能性のみを提供します。完全に制御するには、エキスパートタブを使用する必要があります。

プロジェクト設定

プロジェクトペインのフィールドは自明です。Doxygen の実行が完了すると、結果を探す場所が「宛先ディレクトリ」になります。Doxygen は、デフォルトで各出力形式を個別のサブディレクトリに配置します。

ウィザードタブ: プロジェクト設定

動作モード

モードペインでは、Doxygen がソースをどのように参照するかを選択できます。デフォルトでは、ドキュメント化されたもののみを検索します。さらに、出力で使用される用語を、使用されている主要なプログラミング言語により適合するように変更できます (これは Doxygen がソースコードを解析する方法には影響しません)。

ウィザードタブ: 動作モード

生成する出力

出力ペインでは、Doxygen が生成する出力の種類を選択できます。HTML と ${\LaTeX}$ には、追加のオプションが利用可能です。

ウィザードタブ: 生成する出力

生成する図

Doxygen は多数の図を生成できます。図ペインを使用して、生成する図を選択できます。ほとんどの図には、GraphViz パッケージの dot ツールが必要です。これは別途インストールする必要があります。

ウィザードタブ: 生成する図

エキスパートタブ

エキスパートタブはいくつかのペインに分かれています。

左上ペイン: 利用可能なトピックペイン (つまり、設定ファイルのセクション) が表示されます。トピックをクリックすると、対応する設定が右ペインに表示されます。
左下ペイン: ヘルプペインです。右ペインの設定名にカーソルを合わせると更新されます。
右ペイン: 設定ペインです。このペインには、選択したトピックに利用可能な設定が表示されます。設定名が赤色で表示されている場合、その設定はデフォルト値と異なります。設定がグレーアウトされている場合、その設定は無効になっている別の設定に依存しています。どの設定に依存しているかは、左下のヘルプペインに表示されます。

エキスパートタブのいくつかのオプション

入力フィールドの表示は、設定オプションのタイプによって異なります。

各ブールオプション (設定ファイルで YES または NO で回答されるオプション) にはチェックボックスがあります。典型的なフィールドは次のようになります。
固定された値のセットのいずれかを取る項目 (例: OUTPUT_LANGUAGE) には、コンボボックスが使用されます。典型的なフィールドは次のようになります。
範囲内の整数値を取る項目には、スピンボックスが使用されます。典型的なフィールドは次のようになります。
自由形式の文字列型オプションには、1行編集フィールドがあります。典型的なフィールドは次のようになります。

さらに、文字列フィールドにファイルまたはフォルダ名が含まれるべき場合、ファイル/フォルダ選択ダイアログを開始する特別なボタンとがあります。ファイルの場合の典型的なフィールドは次のようになります。

フォルダは次のようになります。

ファイルとフォルダの両方が許可されている場合、見た目は次のようになります。

ファイルが画像を表す場合、Doxygen は選択された画像を表示しようとします。その場合、典型的なフィールドは次のようになります。
文字列のリストを取るオプションの場合、編集フィールドが表示され、その下に編集不可能なリストが表示されます。ボタンは編集フィールドの文字列をリストに追加し、ボタンはリストから選択された文字列を削除します。ボタンをクリックすると、リスト内の選択された項目を編集フィールドに入力された文字列に置き換えることができます。典型的なフィールドは次のようになります。

さらに、リストにファイル名やフォルダ名が含まれる場合、ファイル/フォルダ選択ダイアログを開始する特別なボタンとがあります。ファイルの場合の典型的なフィールドは次のようになります。

フォルダの場合は次のようになります。

ファイルとフォルダの両方が許可されている場合、見た目は次のようになります。

実行タブ

実行タブでは、指定された設定で Doxygen を実行し、HTML 結果を表示し、使用された設定を表示し、出力ペインに表示された出力を保存する機能を提供します。

実行タブ

Doxygen 実行時の追加コマンドラインオプションを指定します。: Doxygen 実行時に使用される追加オプションを指定するフィールドです（例：デバッグ目的）。
Doxygen を実行: クリックすると Doxygen の実行が開始されます。「Doxygen によって生成された出力」ペインには、Doxygen の実行中に生成されたメッセージが表示されます。Doxygen を実行する前に、設定を保存する必要があります。
HTML 出力を表示: このボタンをクリックすると、デフォルトのブラウザでメインの HTML 出力ページが開きます。このボタンは Doxygen の終了後に有効になります。
設定を表示: このボタンをクリックすると、Doxygen の実行時に使用される設定が表示されます。結果は「Doxygen によって生成された出力」ペインに簡潔なテキスト形式で表示されます。
簡潔に: チェックすると、「設定を表示」ボタンはデフォルト設定と異なる設定のみをリストします (doxygen -x と同様)。
ログを保存 ...: 「Doxygen によって生成された出力」ペインからの情報を、ユーザーが指定したファイルに保存します。

メニューオプション

ファイルメニュー

設定の読み込みと保存に役立ついくつかの項目があるファイルメニュー。

ファイルメニュー

開く...: ファイル選択ダイアログに基づいて、ディスクから設定ファイルを読み込みます。未保存の設定が存在する場合、操作を確認するプロンプトが表示されます。
最近開いたファイル: 最近保存した設定ファイルをすばやく読み込みます。未保存の設定が存在する場合、操作を確認するプロンプトが表示されます。このメニュー項目は、リストに最近のファイルがある場合にのみアクセス可能です。
保存: 設定ファイルをディスクに保存します。設定ファイルがすでに設定されている場合はこのファイル名が使用され、そうでない場合は選択ダイアログが表示されます。ファイルがすでに存在する場合は確認が必要です。
名前を付けて保存...: 現在の設定を特定の名前でディスクに保存します。このファイル名が現在の設定ファイル名になります。
終了: Doxywizard を終了します。未保存の設定が存在する場合、操作を確認するプロンプトが表示されます。

設定メニュー

工場出荷時のデフォルトにリセット: 工場出荷時のデフォルト設定を、使用するデフォルト設定として復元します。操作を確認するプロンプトが表示されます。このメニュー項目は、現在の設定がデフォルト設定と異なる場合にのみアクセス可能です。
起動時に現在の設定を使用: 現在の設定を、次回 GUI 起動時に使用するデフォルトとして保存します。操作を確認するプロンプトが表示されます。
最近のリストをクリア: ファイルメニューの「最近開いたファイル」リストをクリアします。このメニュー項目は、「最近開いたファイル」リストに最近のファイルがある場合にのみアクセス可能です。
Doxygen を実行: この項目を選択することは、実行タブに切り替えて「Doxygen の実行」ボタンをクリックすることと同じです。

ヘルプメニュー

オンラインマニュアル: システムで定義されたデフォルトの HTML ブラウザで、Doxygen ホームページから Doxygen マニュアルを開きます。
Doxygen について: バージョン情報が記載された「Doxygen について」ダイアログを表示します。

次のセクションに進むか、インデックスに戻ります。