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

时间:2022-10-30 09:37:12

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; 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:

我想保持头文件没有doxygen评论;它们都在.cpp文件中。对于函数,类,typedef等,这不是问题。我也可以像这样记录枚举本身:

/*!
  \enum MyClass::MyEnum

  Foo Bar Baz

  \value FirstEnumValue <- doesn't work
*/

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

但是如何记录枚举值呢?

Thanks!

1 个解决方案

#1


You need to use \var according to the docs

您需要根据文档使用\ var

#1


You need to use \var according to the docs

您需要根据文档使用\ var