【发布时间】:2013-04-20 15:19:30
【问题描述】:
通常,当您使用 Doxygen 记录代码时,您可以将 cmets 直接放在要记录的任何内容之前或之后。但是,我现在正在处理一些使用结构命令来注释代码的代码(如此处所述: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 能够识别枚举及其所有值,但它忽略了值的描述。有人可以告诉我使用结构化命令记录枚举的正确方法是什么吗? (我希望能够避免将所有这些更改为将文档放在值之前或之后的格式)。
【问题讨论】:
-
这似乎在 Doxygen 1.8.3.1 中运行良好。你使用的是什么版本的 Doxygen?您使用的是默认的 Doxygen 配置文件吗?您能否提供您看到的输出的屏幕截图?
标签: enums documentation doxygen