doxygen:如何记录 \enum 值外线?

发布于 2024-07-27 21:28:14 字数 330 浏览 1 评论 0原文

准确地说:我知道如何在声明时对枚举进行 dox,但我想对它们进行脱线操作。

我想让头文件不含 doxygen 注释; 它们都在 .cpp 文件中。 对于函数、类、typedef 等来说这不是问题。 我还可以像这样记录 enum 本身:

/*!
  \enum MyClass::MyEnum

  Foo Bar Baz

  \value FirstEnumValue <- doesn't work
*/

但是如何记录 enum呢?

谢谢!

To be precise: I know how to dox enums at the point of declaration, I want to dox them out-of-line instead.

I want to keep the header file free of doxygen comments; they're all in the .cpp file. This is not a problem for functions, classes, typedefs and so on. I can also document the enum itself like this:

/*!
  \enum MyClass::MyEnum

  Foo Bar Baz

  \value FirstEnumValue <- doesn't work
*/

but how do I document the values of the enum there?

Thanks!

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

奈何桥上唱咆哮 2024-08-03 21:28:14

您需要根据 docs 使用 \var

You need to use \var according to the docs

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文