doxygen generated documentation with auto-generated links to qt project

南楼画角 提交于 2019-12-11 02:33:47

问题


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.


回答1:


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!!!




回答2:


Is it possible to configure doxygen to generate links to online qt documentation.

It would have been important for the KDE API documentation, too, but there is no, or at least not a simple way to do it.

However, as you can see on the KDE API page (e.g. KMessageBox and grep for QWidget), you can apply some tricks to at least the method signature, etc, to get the link to the Qt documentation. Perhaps, you could try to apply the same trick to the documentation without doxygen.

In general, you wish to have more than just the doxygen documentation, so I think you would need a more generic approach, respectively.



来源:https://stackoverflow.com/questions/22244779/doxygen-generated-documentation-with-auto-generated-links-to-qt-project

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!