如何使Qt Creator以与Qt库中的函数相同的方式显示我的函数的弹出文档？

Question

当您将鼠标指针放在任何Qt函数/类上时，它会显示一个弹出窗口，其中包含对其功能的简短描述，取自函数/类上方注释中的文档。

对于我的函数/类，我有doxygen格式的文档：

/**
  Returns foo
*/
QString getFoo() {
  return "foo";
}

当使用此功能时，我想在鼠标指针位于函数名称上时查看与我的文档相同类型的弹出窗口。

使用Qt Creator可以做到吗？

Answer 1

不幸的是，Qt Creator（截至最近的版本2.4）不可能即时获取标签。但是，可能有用的是让doxygen运行，并告诉它创建qch文件。如果您注册创建的qch文件，您应该获得鼠标悬停，甚至是正确的帮助文件。有关Ogre3D如何做到这一点，请参阅http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help。 YMMV，如果这对于一个快速变化的项目是值得的。对于（半）稳定的库来说，这当然是一个好主意。

相关错误报告：https://bugreports.qt.io/browse/QTCREATORBUG-4557

Answer 2

Qt Creator要求生成的文档具有一些特殊标记，以便检索工具提示文本。我找不到用Doxygen插入这些标记的方法，所以我创建了一个简单的脚本来执行它：

https://github.com/mmmarcos/doxygen2qtcreator

它不是防弹的，但它允许我们将我们的类和方法简介集成到Qt Creator工具提示中。