Doxygen调用图无法被Sphinx+Breathe抓取的相关问题咨询

问题1解答：Doxygen输出调用图到XML的配置 #

你需要额外在Doxyfile中开启以下配置项，默认这些配置为关闭状态，会导致调用图引用不写入XML：

• INCLUDE_GRAPH_IN_XML = YES：这是核心配置，开启后Doxygen会将调用图、被调用图的关联引用写入XML输出
• 确保原有生成调用图的配置已经正确开启：

  HAVE_DOT = YES
  CALL_GRAPH = YES
  CALLER_GRAPH = YES
  GENERATE_XML = YES
  DOT_IMAGE_FORMAT = png
  

配置生效后重新生成Doxygen输出，即可在XML文件中检索到调用图的关联记录，对应图片也会同步输出到xml目录下。

问题2解答：Breathe无法抓取调用图的排查环节 #

按以下顺序排查即可定位问题：

1. 确认Sphinx的conf.py中已经将sphinx.ext.graphviz加入extensions列表，Breathe渲染调用图依赖该扩展实现
2. 检查conf.py中的html_static_path配置，已经将Doxygen输出的调用图存放目录加入静态资源搜索路径，避免生成的HTML文档找不到图片资源
3. 确认Breathe配置的breathe_projects路径准确指向Doxygen输出的xml目录，不要指向html目录
4. 若以上配置都正常，检查你使用的函数是否为静态函数、或Doxygen配置中EXTRACT_STATIC未开启，导致函数信息未写入XML，自然无法关联调用图

问题3解答：手动引入时固定调用图文件名的方案 #

Doxygen生成的调用图文件名是基于函数的唯一标识（函数签名、所属模块、所在文件路径等信息）计算的哈希值，只要函数的上述信息不发生变更，生成的文件名就不会变化。
如果需要更易识别的固定文件名，可自行开发轻量脚本实现：

• 每次Doxygen生成完成后，解析XML目录下的index.xml和各函数对应的XML文件，匹配函数名与对应调用图的哈希标识
• 遍历Doxygen输出的调用图文件，按匹配结果将晦涩的哈希文件名重命名为函数名_cgraph.png这类可识别的固定名称，重命名后的文件名只要你不修改命名规则就不会变化，完全满足手动引入的要求

内容的提问来源于stack exchange，提问作者Lori-Ly