繁体   English   中英

C++ 函数的自定义 Doxygen 永久链接

[英]Custom Doxygen permalinks to c++ functions

我们使用 Doxygen 来记录我们的 C++ 代码,并使用 Breathe 插件将 Doxygen 结果包含在我们的 Sphinx HTML 文档中。 我们想使用 HTML 链接中的命名锚直接跳转到 HTML 文档中的函数,如下所示:

http://path/MyClassDocumentation.html#myFunction(params)

这个想法是使用它们的签名自动跳转到我们可以在运行时动态检索的函数。 我们如何在 C++ Doxygen 注释中创建这些命名锚点? Breathe 创建 HTML 元素,这些元素使用它们的签名和 md5 总和来处理函数。 示例:

<span id="my_class_my_function_1a21be2544e55395e0218006fca87a2a82"></span>

这没有帮助,因为我们无法在运行时使用函数签名跳转到这些 id。 因此,我们要添加我们自己的命名锚点,它应该如下所示:

MyClass::MyFunc(paramList)

我尝试在我们的评论中使用 "\\anchor",但似乎它们被忽略了。 有没有办法获得我们可以在 C++ 代码注释中定义的命名锚点? 还是有另一种方法可以实现这一目标?

编辑:我认为我们需要的是定义自定义 html 永久链接,以从 Doxygen 注释中解决我们的 C++ 代码中的函数。

我有一个类似的问题,想从 docbook 文档链接到 C 的 doxygen 文档。

解决方案是使用 GENERATE_TAGFILE 配置参数从 doxygen 生成标记文件。

然后我使用一些自定义脚本解析标记文件以提取每个函数的锚值。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM