如何使QtCreator显示我的函数的弹出文档,就像它对来自Qt库的函数所做的一样?

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (2)
  • 关注 (0)
  • 查看 (426)

当将鼠标指针放置在任何Qt函数/类上时,它会显示一个弹出,并对它所做的事情进行简短的描述,这是从函数/类上面的注释中的文档中提取的。

对于我的函数/类,我有doxygen格式的文档:

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

当使用此函数时,当鼠标指针位于函数名称上方时,我希望在我的文档中查看相同类型的弹出。

QtCreator能做到这一点吗?

提问于
用户回答回答于

不幸的是,QtCreator(截至最近发布的2.4版)不可能在动态中获取标记。然而,可能的工作是让doxygen运行,并告诉它创建QCH文件。如果注册创建的QCH文件,应该得到鼠标通过,甚至一个适当的帮助文件。见http://www.ogre3d.org/tikiwiki/Integration+API+Document+Into+QT+Creator+HelpOgre3D是怎么做到的。YMMV,如果这对一个快速变化的项目来说是值得的。对于一个(半)稳定的库来说,这当然是个好主意。

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

用户回答回答于

扫码关注云+社区

领取腾讯云代金券