Use own documentation in Qt Creator help mode

前提是你 提交于 2019-12-13 02:56:28

问题


Qt Creator has the convenient feature that I can select any Qt class, press F1 and the Qt documentation for that class opens (see second link below).

Now I would like to have the same functionality for my own classes which are already documented using Doxygen.

I've found the IMHO quite short documentation for the Qt Help Framework and Qt Creator Help Mode. I've also already found the menu in Qt Creator where i could add more help files, but I didn't find anything about how to exactly define my Doxygen and then pack it into a Qt help file so that Qt Creator would find the correct link anchors etc.

Has anybody done this before and can help me out here?


回答1:


Set these doxyfile's variables:

GENERATE_QHP           = YES
QCH_FILE               = <project>.qch
QHP_NAMESPACE          = <namespace>
QHP_VIRTUAL_FOLDER     = doc
QHG_LOCATION           = qhelpgenerator

The ones in <> braces can be anything you want.



来源:https://stackoverflow.com/questions/30321505/use-own-documentation-in-qt-creator-help-mode

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