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

Question

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

7

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会显示生成的文档：

有没有办法在工具提示中也获取简要摘要？我已经尝试了以下所有方法：

但仍然没有摘要。

- Nick Pruehs

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Marcos · Accepted Answer

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

例如，对于MyClass的简要概述必须放置在相应HTML文件的和标记之间。对于方法概述查找，使用更复杂的标记。

如果没有这些标记，简要概述提取将无法工作，并且QtCreator工具提示中将不显示摘要。

遗憾的是，这并没有得到很好的记录，并且据我所知，它在未来版本中可能会发生变化。

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

您还可以尝试：doxygen2qtcreator。

脚本会将那些 Qt 标记插入到 Doxygen 生成的 HTML 文件中（在使用 qhelpgenerator 生成 qch 文件之前）。这对我来说有效，但我尚未测试过它是否适用于更新的 Doxygen/Qt 版本。