准备

  • 获取源代码
  • 安装带有图形界面前端的 Doxygen
  • 安装 Graphviz/Dot 工具(见注意事项)

构建

  使用 Doxywizard(Doxygen GUI) 打开目录下的 Doxygen 文件,选择 Run 选项卡,点击 Run doxygen 按钮等待完成即可。

  构建文档的内容主要来自源文件中的注释。

  默认的输出路径在 doc/html 。打开其中的 index.html 进入主页。

注意事项

  • Dot 工具的路径是被硬编码的。
    • 如果不确定安装的位置,使用前清空 DOT_PATH ,并设置 PATH 环境变量使二进制文件能被找到。可以直接编辑 Doxyfile 或者在 Expert 选项卡的 Dot 项中设置 DOT_PATH
  • 当前配置使用 DOT_IMAGE_FORMATsvg 而不是默认的 png ,生成的文件不支持 Intenet Explorer 9 以前版本的浏览器。