如何在QtCreator工具提示中显示API文档？

Question

QtCreator提供了内置Qt功能的工具提示，如下所示：

我已将一些文档添加到我自己的函数中，如下所示：

        /**
         * @brief serialize Writes the passed field definition set to the specified device.
         * @param device Device to write the field definition set to.
         * @param fieldDefinitionSet Field definition set to write.
         */
        void serialize(QIODevice& device, const FieldDefinitionSet& fieldDefinitionSet) const;

运行Doxygen和qhelpgenerator，我创建了自己的.qhp文件并将其添加到QtCreator。但是，QtCreator仍然没有在工具提示中显示我的简短摘要：

我认为QtCreator基本上已经识别了我的.qhp文件，因为点击F1会显示生成的文档：

有没有办法在工具提示中获得简短的摘要？我已尝试过

中的所有内容

• Qt5 reference documentation: qch files
• Use own documentation in Qt Creator help mode
• Using automatic documentation of my own function with Qt Creator?

但仍然没有摘要。

Answer 1

QtCreator从HTML文档文件中提取信息的方式需要一个非常特定的结构才能工作。

例如，MyClass的简短摘要必须放在相应HTML文件中的<!-- $$$MyClass-brief -->和<!-- $$$MyClass -->标记之间。对于方法摘要查找，使用更复杂的标记。

如果没有这个，简短的提取就不会起作用，QtCreator工具提示中也不会显示摘要。

可悲的是，没有详细记录，AFAIK可能会在将来的版本中发生变化。

如果您真的感兴趣，可以查看QtCreator来源（htmldocextractor.cpp）。我认为Qt帮助文件（在Qt / Docs目录中）可以被视为工作示例。

您还可以尝试：doxygen2qtcreator。

脚本在Doxygen生成的HTML文件中插入这些Qt标记（因此在使用qhelpgenerator生成qch文件之前）。它对我有用，但我没有用更新的Doxygen / Qt版本进行测试。