简体   繁体   English

Doxygen:没有为非成员函数生成超链接

[英]Doxygen: no hyperlinks generated for non-member functions

I'm using Doxygen 1.8.14, in my generated documentation, the brief descriptions of class member functions at the top of each html file corresponding to a class and all mentions of such functions in the same html document point to the full function documentation further down on the page via hyperlinks. 我使用的是Doxygen 1.8.14,在生成的文档中,每个与类相对应的html文件顶部的类成员函数的简要说明,以及在同一html文档中对此类函数的所有提及进一步指向完整的功能文档通过超链接在页面上

However, this does not happen (both cases) for functions which are not class members. 但是,对于不是类成员的函数,这不会发生(两种情况)。

To me this seems like Doxygen is broken or is there something I'm missing? 在我看来,Doxygen似乎坏了,或者我缺少什么? I believe that according to the documentation this should work. 我相信根据文档,这应该可行。

Doxygen, being derived from JavaDoc to a degree, is somewhat class-centric. 从JavaDoc派生的Doxygen在某种程度上是以类为中心的。 As such, documented elements which are not members of a class need to be members of something for them to appear in the documentation. 因此,不是类成员的已记录元素必须成为某种东西的成员才能出现在文档中。

Your choices are to make them members of a documented file (which requires that you document the file they appear within), a documented namespace, or to add them to an existing documentation module/group via \\addtogroup and similar documentation tools. 您的选择是使它们成为文档化文件的成员(这要求您对它们出现在其中的文件进行文档化),文档化名称空间,或者通过\\addtogroup和类似文档工具将它们添加到现有文档模块/组中。

This is not necessarily a bad thing. 这不一定是一件坏事。 Documentation modules are very useful for separating out related functions/classes. 文档模块对于分离相关功能/类非常有用。 And documenting files and namespaces is good too, so that users can see a list of what is a part of each file or namespace. 记录文件和名称空间也很好,因此用户可以看到每个文件或名称空间的组成部分的列表。

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

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