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

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?

但仍然没有摘要。

最佳答案

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

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

否则，简短的提取将无法进行，并且QtCreator工具提示中将不会显示任何摘要。

遗憾的是，这没有得到很好的记录，并且AFAIK在将来的版本中可能会更改。

如果您真的有兴趣，可以看看QtCreator的源代码(htmldocextractor.cpp)。而且我认为Qt帮助文件(位于Qt/Docs目录中)可以看作是有效的示例。

您也可以尝试:doxygen2qtcreator。

该脚本将这些Qt标记插入Doxygen生成的HTML文件中(因此，在使用qhelpgenerator生成qch文件之前)。它对我有用，但是我还没有在较新的Doxygen/Qt版本中进行过测试。

关于qt - 如何在QtCreator工具提示中显示API文档？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/39430886/