简体   繁体   English

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

[英]doxygen: how do I document \enum values out-of-line?

To be precise: I know how to dox enums at the point of declaration, I want to dox them out-of-line instead. 确切地说:我知道如何在声明时使用dox枚举,我想把它们排除在外。

I want to keep the header file free of doxygen comments; 我想保持头文件没有doxygen评论; they're all in the .cpp file. 它们都在.cpp文件中。 This is not a problem for functions, classes, typedefs and so on. 对于函数,类,typedef等,这不是问题。 I can also document the enum itself like this: 我也可以像这样记录enum本身:

/*!
  \enum MyClass::MyEnum

  Foo Bar Baz

  \value FirstEnumValue <- doesn't work
*/

but how do I document the values of the enum there? 但是如何记录enum 呢?

Thanks! 谢谢!

您需要根据文档使用\\ var

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM