不要在Doxygen中看到(链接)Qt类

时间:2015-12-10 18:45:40

标签: qt doxygen

这是doxygen generated documentation with auto-generated links to qt project的后续行动, 博客here

中也有介绍

添加了标记文件:

TAGFILES = qtcore.tags=http://doc.qt.io/qt-5/ qtgui.tags=http://doc.qt.io/qt-5/ \
           qtwidgets.tags=http://doc.qt.io/qt-5/ qtxml.tags=http://doc.qt.io/qt-5/ \
           qtnetwork.tags=http://doc.qt.io/qt-5/

GENERATE_TAGFILE = mytags

Crosscheck,作为一个例子,这里有效:http://doc.qt.io/qt-5/qtcore.tags

尽管如此,我没有看到Qt类的任何链接(我希望QString成为一个链接)

No link for QString/Qobject

我做错了什么?顺便说一句,像\copydoc QString::toInt这样的东西呢?

1 个答案:

答案 0 :(得分:2)

您是否检查过.tags个文件的位置?

.tags文件就像是将符号映射到文档相对链接的索引。这就是为什么你指定路径到标记文件实际文档URL 的地方,其中记录了符号(顺便说一下,它也可以是Qt的本地路径&# 39; s docs。

换句话说,你应该指定:

TAGFILES = path/to/a/tags/file=URL

您可以在Qt目录中找到这些.tags文件(通常在QT_DIR/doc/html中)。

将它们复制到项目目录中可能是个好主意,以避免使用绝对路径。因此,如果您有以下项目结构:

myproject/
    Doxyfile
    src/
    doc/
        html/
        qt/
            qt.tags

然后你的Doxyfile应该包含:

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

然后,您在文档中对Qt符号的所有引用都将链接到Doxygen生成的html输出中。

此外,GENERATE_TAGFILE标记仅在您要从其他项目链接到您的文档时才有用。