Search code examples
qtdocumentationdoxygen

doxygen generated documentation with auto-generated links to qt project

I have a project with use Qt extensively. The documentation is generated with doxygen. Is it possible to configure doxygen to generate links to online qt documentation.

For example,

/**
 * Implements QAbstractListModel.
 */

The comment like this would have in the output an internet link to Qt online documentation of QAbstractListModel.

Solution

  • You can use the TAGFILES option on your Doxyfile then you can setup the online link as TAGFILE. See:

    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/

    More information here: Linking to external documentation

    I was looking on internet about that and in fact I couldn't find the answer. I just tried it and it worked so great for me!!!