Enums 使用结构命令(doxygen)记录枚举
通常,当您使用Doxygen编写代码文档时,您会将注释直接放在您编写的任何文档之前或之后。但是,我现在正在使用一些代码,这些代码使用结构化命令对代码进行注释(如下所述:)。基本上,所有文档都包含在文件的开头 我不喜欢这种方法,但它似乎在大多数情况下都有效,但枚举是个例外。下面是一个如何记录枚举的示例Enums 使用结构命令(doxygen)记录枚举,enums,documentation,doxygen,Enums,Documentation,Doxygen,通常,当您使用Doxygen编写代码文档时,您会将注释直接放在您编写的任何文档之前或之后。但是,我现在正在使用一些代码,这些代码使用结构化命令对代码进行注释(如下所述:)。基本上,所有文档都包含在文件的开头 我不喜欢这种方法,但它似乎在大多数情况下都有效,但枚举是个例外。下面是一个如何记录枚举的示例 /*! \enum MyEnum A description of the enum. \var EnumValue1 \im
/*!
\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能够识别枚举及其所有值,但它会忽略这些值的描述。有人能告诉我使用结构化命令记录枚举的正确方法吗?(我希望能够避免将所有这些更改为将文档放在值之前或之后的格式)。尝试:
\var MyEnum EnumValue1
Description of value.
这在Doxygen 1.8.3.1中似乎运行良好。您使用的是什么版本的强氧剂?您是否使用默认的Doxygen配置文件?你能提供你看到的输出的屏幕截图吗?