在 Qt Creator 帮助模式下使用自己的文档 [英] Use own documentation in Qt Creator help mode

问题描述

Qt Creator 有一个方便的功能，我可以选择任何 Qt 类，按 F1 并打开该类的 Qt 文档(参见下面的第二个链接).

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).

现在我想为我自己的类拥有相同的功能，这些类已经使用 Doxygen 进行了记录.

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

我发现恕我直言，Qt 帮助框架 和 Qt Creator 帮助模式.我也已经在 Qt Creator 中找到了可以添加更多帮助文件的菜单，但是我没有找到任何关于如何准确定义我的 Doxygen 然后将其打包到 Qt 帮助文件中以便 Qt Creator 找到正确的链接锚等

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?

推荐答案

设置这些 doxyfile 的变量:

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.

这篇关于在 Qt Creator 帮助模式下使用自己的文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！