首页 > 解决方案 > Doxygen 调用图:命名约定,与 Sphinx (Breathe) 一起使用

问题描述

大师们,

我正在使用 doxygen 记录 C 代码。然后我使用 Breathe 和 Sphinx 来创建我的文档。

问题: Doxygen 调用图没有被拉入 Sphinx/Breathe 生成的最终文档中。

正常工作:

  1. Doxygen 根据要求生成所有调用图。
  2. callgraph .dot 和 .png 文件位于 html 目录中。
  3. 如果我查看 html 源代码,则调用图已插入到函数文档中。

我试过的:

  1. 由于 Breathe 使用 xml,我目视检查了 doxygen xml 输出目录,我没有看到该目录中的调用图。我还搜索了 png 和 dot 以查看它是否嵌入到 .xml 中,但没有找到任何证据。
  2. 一种可能的解决方法:我可以使用以下指令之一在我的 reStructuredText 中包含图像 png:..image、或 ..figure 或 ..graphviz。然而,doxygen 给文件的名称是神秘的,所以我犹豫不决。示例:group___b_i_s_s_c_s___s_y_s___i_n_i_t_gac5ed08df903ed0d3f0dfea740ee48d35_cgraph.png

问题 1:
我是否可能缺少将调用图包含在 xml 和 html 中的配置设置?

问题 2: 我应该检查的其他任何事情或关于为什么 Breathe 没有拾取呼叫图的想法?

问题 3: 如果我在 RST 中使用文件名,我如何确信 .png 或 .dot 文件名在未来执行 doxygen 时不会改变?

标签: python-sphinxdoxygen

解决方案


推荐阅读