doxygen:如何记录 \enum 值外线?
准确地说:我知道如何在声明时对枚举进行 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 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
您需要根据 docs 使用 \var
You need to use \var according to the docs