Question

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

例如，

/**
 * Implements QAbstractListModel.
 */

这样的评论会在输出中显示QAbstractListModel的Qt在线文档的互联网链接。

Answer 1

您可以在Doxyfile上使用TAGFILES选项，然后可以将在线链接设置为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/

此处提供更多信息：Linking to external documentation

我在网上看到这个，事实上我找不到答案。我刚尝试过，它对我来说真的很棒!!!

Answer 2

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

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

但是，正如您在KDE API page上看到的（例如KMessageBox和grep for QWidget），您可以应用一些技巧至少方法签名等，以获取Qt文档的链接。也许，您可以尝试在没有doxygen的情况下将相同的技巧应用于文档。

一般来说，你希望不仅仅有doxygen文档，所以我认为你需要一个更通用的方法。

Answer 3

我写了一个utility，用于从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/

从该存储库中生成的文档的

Here's an example个。所有与Qt文档的链接都是自动的，包括可扩展树中所有继承的内容。

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

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

3 个答案: