doxygen graphviz

### Doxygen与Graphviz的集成

Doxygen是一款强大的文档生成工具，支持多种编程语言并能自动生成项目文档。而Graphviz则是一个开源图形可视化软件包，可以用来绘制各种类型的图表。两者结合能够显著提升代码库及其内部关系的可视化效果。

#### 安装配置

要使Doxygen调用Graphviz的功能，在安装好这两个程序之后，还需要确保环境变量PATH中包含了它们各自的执行文件路径。对于Windows用户来说，这意味着将`C:\Program Files\Graphviz\bin`(假设在此目录下安装了Graphviz)加入系统的Path环境变量；而对于Linux/MacOS用户，则通常是通过包管理器安装后自动完成此设置[^1]。

#### 配置Doxyfile

编辑项目的Doxyfile配置文件以启用Graphviz特性：

HAVE_DOT        = YES           # 启动dot命令的支持
CLASS_DIAGRAMS  = YES          # 开启类图生成功能
HIDE_UNDOC_RELATIONS = NO      # 显示未记录的关系
DOT_PATH        =               # 如果不是默认位置, 则指定Dot可执行文件的位置
DOTFILE_DIRS    = .            # Dot输入文件所在的相对或绝对路径
MAX_DOT_GRAPH_WIDTH = 640     # 设置最大宽度像素数
MAX_DOT_GRAPH_HEIGHT= 480     # 设置最大高度像素数

上述选项允许Doxygen利用Graphviz创建更丰富的图像化描述，比如继承树、协作图等，并控制这些图片的一些基本属性[^2]。

#### 使用示例

一旦完成了以上步骤，就可以在源码注释中标记特定的关键字让Doxygen知道何时应该应用Graphivz来进行渲染。例如:

/// @brief A simple class demonstrating how to document code using Doxygen.
///
/// This is an example of a documented function that will be included in the generated documentation.
/// \dot
/// digraph G {
///   "ClassA" -> "ClassB";
/// }
/// \enddot
class ClassA {};

这段特殊的标记告诉Doxygen在这个地方插入由Graphviz解析的一张简单的有向图，展示了两个类之间的关联关系[^3]。