Doxywizard 是一个用于配置和运行 Doxygen 的 GUI 前端。

启动 Doxywizard 时，可以指定一个现有的配置文件作为参数，否则将使用默认设置作为起点。

启动 Doxywizard 时，它会显示主窗口（实际外观取决于所使用的平台）。

主窗口

用户界面由以下部分组成

菜单选项

在菜单栏中，可以使用以下部分：文件菜单、设置菜单和帮助菜单。

指定 Doxygen 将运行的工作目录

使用 选择... 按钮可以选择一个目录。当使用配置文件启动 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 手册。
关于: 显示带有版本信息的“关于”对话框。

转到下一部分或返回索引。