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 マニュアルを開きます。
バージョン情報: バージョン情報を含む [バージョン情報] ダイアログを表示します。

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