Doxywizard 是用于配置和运行 Doxygen 的图形用户界面前端。

启动 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”按钮

帮助菜单

在线手册: 在系统默认的 HTML 浏览器中打开 Doxygen 主页上的 Doxygen 手册。
关于: 显示一个关于对话框，包含版本信息。

前往下一节或返回索引。