【问题标题】:Doxygen: no hyperlinks generated for non-member functionsDoxygen:没有为非成员函数生成超链接
【发布时间】:2018-09-12 18:41:09
【问题描述】:

我使用的是 Doxygen 1.8.14,在我生成的文档中,每个 html 文件顶部的类成员函数的简要描述对应于一个类,并且在同一个 html 文档中对此类函数的所有提及都指向完整通过超链接将功能文档放在页面下方。

但是,对于不是类成员的函数,这不会发生(两种情况)。

对我来说,这似乎是 Doxygen 坏了,还是我缺少什么?我相信根据文档,这应该可行。

【问题讨论】:

    标签: c++ doxygen


    【解决方案1】:

    Doxygen 在一定程度上是从 JavaDoc 派生的,有点以类为中心。因此,不是类成员的文档化元素需要是 something 的成员才能出现在文档中。

    您的选择是使它们成为文档文件(这要求您记录它们出现在其中的文件)、文档命名空间的成员,或者通过\addtogroup 和类似的文档工具将它们添加到现有文档模块/组中.

    这不一定是坏事。文档模块对于分离相关的函数/类非常有用。记录文件和命名空间也很好,这样用户就可以看到每个文件或命名空间的组成部分的列表。

    【讨论】:

    • 我已经记录了它们出现的类(通过在文件顶部添加一个包含 @file 标记的注释块),所以这似乎不起作用。记录包含的命名空间确实有效,我不想记录它,但也许我会接受它(或尝试分组)。
    • @peter 请在您的问题中添加一个示例,包括对您的 Doxyfile 的更改。您的设置可能不是 100% 正确。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2011-03-22
    • 1970-01-01
    • 2014-07-26
    • 1970-01-01
    • 2012-08-15
    • 2012-01-04
    • 1970-01-01
    相关资源
    最近更新 更多