doxygen生成的文档,带有自动生成的qt项目链接

doxygen生成的文档,带有自动生成的qt项目链接,qt,documentation,doxygen,Qt,Documentation,Doxygen,我有一个广泛使用Qt的项目。文档是用doxygen生成的。是否可以配置doxygen以生成指向在线qt文档的链接 比如说, /** * Implements QAbstractListModel. */ 这样的注释在输出中会有一个指向QabStretcListModel的Qt在线文档的internet链接 是否可以配置doxygen以生成指向在线qt文档的链接 这对于KDEAPI文档来说也很重要,但是没有,或者至少没有一种简单的方法可以做到这一点 但是,正如您在上所看到的(例如KMessa

我有一个广泛使用Qt的项目。文档是用doxygen生成的。是否可以配置doxygen以生成指向在线qt文档的链接

比如说,

/**
 * Implements QAbstractListModel.
 */
这样的注释在输出中会有一个指向QabStretcListModel的Qt在线文档的internet链接

是否可以配置doxygen以生成指向在线qt文档的链接

这对于KDEAPI文档来说也很重要,但是没有,或者至少没有一种简单的方法可以做到这一点

但是,正如您在上所看到的(例如KMessageBox和grep for QWidget),您可以至少对方法签名等应用一些技巧,以获得到Qt文档的链接。也许,您可以尝试在没有doxygen的情况下对文档应用相同的技巧

通常,您希望的不仅仅是doxygen文档,因此我认为您需要一种更通用的方法。

您可以在Doxyfile上使用该选项,然后可以将联机链接设置为TAGFILE。见:

TAGFILES = qtcore.tags=http://qt-project.org/doc/qt-4.8/ \
qtgui.tags=http://qt-project.org/doc/qt-4.8/ \
qtwidgets.tags=http://qt-project.org/doc/qt-4.8/ \
qtxml.tags=http://qt-project.org/doc/qt-4.8/ \
qtnetwork.tags=http://qt-project.org/doc/qt-4.8/
更多信息请点击此处:

我在网上查了一下,事实上我找不到答案。我刚试过,它对我来说太棒了

我编写了一个脚本,从Qt docs安装文件夹中的选定模块复制
.tags
文件,并将它们放在Doxygen配置的本地位置。它将可选地将输入文件连接到一个大的
.tags
文件中,因此如果链接到联机帮助(而不是生成.qhp),那么Doxygen配置将变得更加简单

如果我有:

project/
  doc/
    Doxyfile
    html/
    tagfiles/
      qt.tags
  src/
单个文件可以这样使用:

TAGFILES=TAGFILES/qt.tags=https://doc.qt.io/qt-5/

或QHP:

TAGFILES = \
     tagfiles/qtcore.tags=qthelp://org.qt-project.qtcore/qtcore/  \
     tagfiles/qtgui.tags=qthelp://org.qt-project.qtgui/qtgui/     \
     tagfiles/qtwidgets.tags=qthelp://org.qt-project.qtwidgets/qtwidgets/ 
从该回购协议生成的单据数量。所有到Qt文档的链接都是自动的,包括可扩展树中的所有继承内容

添加较大的Qt标记明显减慢了Doxygen的运行速度,因此我肯定会将导入的标记限制为仅需要链接到的Qt模块

更新:Qt为枚举值生成标记时存在一个错误(在Qt 5.15.0中已修复),该错误阻止Doxygen生成指向这些值的正确链接。我添加了一个用于修复标记文件的工具,还更新了顶部链接的复制实用程序,以实现枚举修复