Use own documentation in Qt Creator help mode

2019-09-12 08:41发布

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?

标签: qt qt-creator
1条回答
虎瘦雄心在
2楼-- · 2019-09-12 09:41

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.

查看更多
登录 后发表回答