如何在 QtCreator 工具提示中显示 API 文档?
How to show API documentation in QtCreator tooltips?
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
- Using automatic documentation of my own function with Qt Creator?
但还是没有总结。
QtCreator 从 HTML 文档文件中提取信息的方式需要非常特定的结构才能工作。
例如MyClass
的摘要必须放在对应的HTML文件中的<!-- $$$MyClass-brief -->
和<!-- $$$MyClass -->
标记之间。对于方法摘要查找,使用了更复杂的标记。
没有这个,简短的提取将无法工作,QtCreator 工具提示中将不会显示任何摘要。
遗憾的是,这没有很好的记录,据我所知,它可能会在未来的版本中发生变化。
如果您真的有兴趣,可以查看 QtCreator 源代码 (htmldocextractor.cpp)。我想 Qt 帮助文件(在 Qt/Docs 目录中)可以被视为 工作示例。
您也可以尝试:doxygen2qtcreator。
脚本将这些 Qt 标记插入 Doxygen 生成的 HTML 文件中(因此在使用 qhelpgenerator 生成 qch 文件之前)。它对我有用,但我没有用较新的 Doxygen/Qt 版本对其进行测试。
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
- Using automatic documentation of my own function with Qt Creator?
但还是没有总结。
QtCreator 从 HTML 文档文件中提取信息的方式需要非常特定的结构才能工作。
例如MyClass
的摘要必须放在对应的HTML文件中的<!-- $$$MyClass-brief -->
和<!-- $$$MyClass -->
标记之间。对于方法摘要查找,使用了更复杂的标记。
没有这个,简短的提取将无法工作,QtCreator 工具提示中将不会显示任何摘要。
遗憾的是,这没有很好的记录,据我所知,它可能会在未来的版本中发生变化。
如果您真的有兴趣,可以查看 QtCreator 源代码 (htmldocextractor.cpp)。我想 Qt 帮助文件(在 Qt/Docs 目录中)可以被视为 工作示例。
您也可以尝试:doxygen2qtcreator。
脚本将这些 Qt 标记插入 Doxygen 生成的 HTML 文件中(因此在使用 qhelpgenerator 生成 qch 文件之前)。它对我有用,但我没有用较新的 Doxygen/Qt 版本对其进行测试。