如何使 Qt Creator 以与 Qt 库中的函数相同的方式显示我的函数的弹出文档？
当您将鼠标指针放在任何 Qt 函数/类上时，它会显示一个弹出窗口，其中包含其功能的简短描述，取自函数/类上方注释中的文档。
对于我的函数/类，我有 doxygen 格式的文档：
/**
Returns foo
*/
QString getFoo() {
return "foo";
}
使用此函数时，当鼠标指针位于函数名称上方时，我想查看与我的文档相同类型的弹出窗口。
Qt Creator 可以做到这一点吗？
When you place the mouse pointer over any Qt function/class it shows a pop-up with short description of what it does, taken from the docs in the comment above the function/class.
For my functions/classes I have documentation in the doxygen format:
/**
Returns foo
*/
QString getFoo() {
return "foo";
}
When this function is used, I want to view the same type of pop-up with my docs when the mouse pointer is over the function name.
Is it possible to do that with Qt Creator?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（2）
不幸的是，Qt Creator（从最近发布的 2.4 开始）不可能即时获取标签。然而，可能有效的方法是让 doxygen 运行，并告诉它创建 qch 文件。如果您注册创建的 qch 文件，您应该获得鼠标悬停，甚至一个正确的帮助文件。请参阅 http://www.ogre3d.org/tikiwiki /Integrating+API+documentation+into+Qt+Creator+Help 了解 Ogre3D 是如何做到的。 YMMV 如果这对于一个快速变化的项目来说是值得的。对于（半）稳定的库来说这当然是一个好主意。
相关错误报告：https://bugreports.qt.io/browse/QTCREATORBUG-4557
Unfortunately it's not possible for Qt Creator (as of the recently release 2.4) to pick up the tags on-the-fly. However, what might work is to let doxygen run, and tell it to create qch files. If you register the created qch file, you should get mouse-over and even a proper help file. See http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help for how Ogre3D does it. YMMV if that's worth it for a fast-changing project. It's certainly a good idea for a (semi-)stable library.
Relevant bug report: https://bugreports.qt.io/browse/QTCREATORBUG-4557
Qt Creator 要求生成的文档具有一些特殊标记，以便检索工具提示文本。我找不到使用 Doxygen 插入这些标记的方法，因此我创建了一个简单的脚本来执行此操作：
https: //github.com/mmmarcos/doxygen2qtcreator
它不是万无一失的，但它允许我们将我们的类和方法摘要集成到 Qt Creator 工具提示中。
Qt Creator requires the generated docs to have some special markers in order to retrieve the tooltip text. I couldn't find a way to insert these markers with Doxygen so I've created a simple script to do it:
https://github.com/mmmarcos/doxygen2qtcreator
It's not bulletproof but it allows us to integrate our classes and methods briefs into Qt Creator tooltips.