Doxywizard 是用於設定和執行 Doxygen 的 GUI 前端介面。

啟動 Doxywizard 時，可以指定一個現有的設定檔作為參數使用，否則將使用預設設定作為起點。

當您啟動 Doxywizard 時，它將顯示主視窗（實際外觀取決於使用的平台）。

主視窗

使用者介面包含以下部分

選單選項

在選單列中，可以使用以下部分：檔案選單、設定選單和說明選單。

指定 Doxygen 將從中執行的工作目錄

使用 Select... 按鈕可以選擇一個目錄。當 Doxywizard 使用設定檔啟動，或使用開啟命令載入設定檔時（請參閱：檔案選單），此設定檔的目錄將用作工作目錄。

使用精靈和/或專家標籤設定 Doxygen...

精靈標籤: 使用此標籤可以快速設定最重要的設定，其餘選項則保留預設值。
專家標籤: 使用此標籤可以存取完整的設定選項。
執行標籤: 使用此標籤可以執行 Doxygen 並檢視使用的設定。

可以在這些標籤之間切換，例如，您可以從精靈標籤開始，然後切換到專家標籤來微調一些設定。

設定 Doxygen 後，您需要將設定儲存（請參閱：檔案選單）為磁碟上的檔案。這使得 Doxygen 可以使用該設定，並且允許稍後再次使用相同的設定執行 Doxygen。

由於某些設定選項可能會使用相對路徑，請務必選擇一個作為這些路徑根目錄的工作目錄。這通常是原始碼樹的根目錄，如果設定檔也儲存在此位置，通常會正確填寫。

儲存設定檔並設定工作目錄後，您可以根據所選設定執行 Doxygen。方法是切換到執行標籤，然後按一下「執行 Doxygen」按鈕，或在設定選單中選擇「執行 Doxygen」項目。

Doxygen 執行後，您可以再次按一下相同的按鈕來取消它。Doxygen 產生的輸出會被擷取並顯示在「Doxygen 產生的輸出」窗格中。Doxygen 完成後，可以將日誌儲存為文字檔。

精靈標籤

精靈標籤分為兩個窗格

左窗格: 用於輕鬆設定 Doxygen 的主要主題。按一下主題，對應的設定會顯示在右窗格中。
右窗格: 精靈的設定窗格，在此窗格中，您會找到可供所選主題使用的設定。

精靈只提供快速設定 Doxygen 的可能性，若要完全控制，應使用專家標籤。

專案設定

專案窗格中的欄位不言自明。Doxygen 完成後，目的地目錄是尋找結果的地方。預設情況下，Doxygen 會將每個輸出格式放在單獨的子目錄中。

精靈標籤：專案設定

操作模式

「模式」窗格可讓您選擇 Doxygen 如何檢視您的原始碼。預設值是只尋找已加入文件內容的事物。此外，可以變更輸出中使用的術語，以更好地符合使用的主要程式設計語言（這不會影響 Doxygen 解析原始碼的方式）。

精靈標籤：操作模式

要產生的輸出

「輸出」窗格可讓您選擇 Doxygen 將產生的輸出種類。對於 HTML 和 ${\LaTeX}$ ，還有其他選項可用。

精靈標籤：要產生的輸出

要產生的圖表

Doxygen 可以產生許多圖表。使用「圖表」窗格，您可以選擇要產生的圖表。對於大多數圖表，需要 GraphViz 套件的 dot 工具。這需要單獨安裝。

精靈標籤：要產生的圖表

專家標籤

專家標籤分為許多窗格

左上窗格: 可用的主題窗格（即設定檔中的章節）。按一下主題，對應的設定會顯示在右窗格中。
左下窗格: 說明窗格，當滑鼠停留在右窗格中的設定名稱上方時，此窗格會更新。
右窗格: 設定窗格，在此窗格中，您會找到可供所選主題使用的設定。如果設定的名稱為紅色，則表示該設定具有非預設值。如果設定呈現灰色，則表示該設定取決於另一個已停用的設定。其所依賴的設定會在左下方的說明窗格中指出。

專家標籤中的一些選項

輸入欄位的表示方式取決於設定選項的類型。

對於每個布林選項（設定檔中以 YES 或 NO 回答的那些選項），都有一個核取方塊。一個典型的欄位如下所示
對於採用一組固定值之一的項目（例如OUTPUT_LANGUAGE），會使用一個組合方塊。一個典型的欄位如下所示
對於從範圍取整數值的項目，會使用一個微調方塊。一個典型的欄位如下所示
對於自由格式的字串類型選項，有一個單行編輯欄位。一個典型的欄位如下所示

此外，當字串欄位應包含檔案或資料夾名稱時，會有特殊的按鈕和，用於啟動檔案/資料夾選擇對話方塊。一個典型的檔案欄位如下所示

資料夾欄位如下所示

如果同時允許檔案或資料夾，則外觀如下所示

如果檔案代表影像，Doxygen 也會嘗試顯示所選影像。則一個典型的欄位如下所示
對於採用字串清單的選項，會顯示一個編輯器欄位，下方有一個不可編輯的清單。按鈕會將編輯器欄位中的字串新增至清單，而按鈕會從清單中移除所選字串。按鈕可以用於將清單中的所選項替換為編輯器欄位中輸入的字串。一個典型的欄位如下所示

此外，當清單包含檔案和/或資料夾名稱時，會有特殊的按鈕和，用於啟動檔案/資料夾選擇對話方塊。一個典型的檔案欄位如下所示

資料夾欄位如下所示

如果同時允許檔案和資料夾，則外觀如下所示

執行標籤

「執行」標籤可讓您使用給定的設定執行 Doxygen、檢視 HTML 結果、檢視使用的設定，以及將輸出儲存為輸出窗格中顯示的內容。

執行標籤

指定執行 Doxygen 的其他命令列選項: 用於指定執行 Doxygen 時使用的額外選項的欄位，例如用於偵錯目的。
執行 Doxygen: 按一下此按鈕將開始執行 Doxygen。「Doxygen 產生的輸出」窗格顯示 Doxygen 執行時產生的訊息。在能夠執行 Doxygen 之前，必須先儲存設定。
顯示 HTML 輸出: 按一下此按鈕將在預設瀏覽器中開啟主要的 HTML 輸出頁面。Doxygen 完成後，按鈕將會啟用。
顯示設定: 按一下此按鈕會顯示執行 Doxygen 時使用的設定。結果將以精簡的文字形式顯示在「Doxygen 產生的輸出」窗格中。
精簡: 勾選後，「顯示設定」按鈕將僅列出與預設設定不同的設定（類似於 doxygen -x）。
儲存日誌 ...: 將「Doxygen 產生的輸出」窗格中的資訊儲存到使用者指定的檔案中。

選單選項

檔案選單

檔案選單中有一些用於載入和儲存設定的實用項目。

檔案選單

開啟...: 從磁碟載入設定檔，以檔案選取對話方塊為基礎。如果存在未儲存的設定，系統會要求您確認動作。
開啟最近的檔案: 快速載入最近儲存的設定檔。如果存在未儲存的設定，系統會要求您確認動作。只有當清單中有最近的檔案時，此選單項目才可存取。
儲存: 將設定檔儲存到磁碟。如果已設定設定檔，則會使用此檔案名稱，否則將會出現選取對話方塊。如果檔案已存在，則需要確認。
另存新檔..: 將目前的設定儲存到磁碟，並使用特定的名稱。此檔案名稱將成為目前設定的檔案名稱。
結束: 離開 Doxywizard，如果存在未儲存的設定，系統會要求您確認動作。

設定選單

重設為原廠預設值: 將原廠預設值還原為要使用的預設設定。系統會要求您確認動作。只有當目前的設定與預設設定不同時，此選單項目才可存取。
在啟動時使用目前的設定: 將目前的設定儲存為下次啟動 GUI 時要使用的預設值。系統會要求您確認動作。
清除最近的清單: 清除檔案選單中的「開啟最近的檔案」清單。只有當「開啟最近的檔案」清單中有最近的檔案時，此選單項目才可存取。
執行 Doxygen: 選擇此項目與切換到執行標籤並按一下「執行 Doxygen」按鈕相同

說明選單

線上手冊: 從 Doxygen 首頁在系統定義的預設 HTML 瀏覽器中開啟 Doxygen 手冊。
關於: 顯示一個「關於」對話方塊，其中包含版本資訊。

前往下一節或返回索引。