通常,当您使用Doxygen记录代码时,您可以在您记录的任何内容之前或之后直接放置注释。但是,我现在正在使用一些使用结构命令来注释代码的代码(如下所述:http://www.doxygen.nl/manual/docblocks.html#structuralcommands)。基本上,所有文档都包含在文件的开头。
不是这种方法的粉丝,但它似乎在大多数情况下都有效,除了枚举。这是一个如何记录枚举的例子。
/*!
\enum MyEnum
A description of the enum.
\var EnumValue1
\image html enumimage.png
Description of value.
\var EnumValue2
\image html enumimage.png
Description of value.
*/
Doxygen能够识别枚举及其所有值,但忽略了值的描述。有人可以告诉我使用结构命令记录枚举的正确方法是什么? (我希望能够避免将所有这些更改为在值之前或之后放置文档的格式。)
答案 0 :(得分:0)
尝试:
\var MyEnum EnumValue1
Description of value.