2013-04-26 35 views
0

通常,当您使用Doxygen记录代码时,可以将注释直接放在记录的任何记录之前或之后。不过,我现在正在使用一些使用结构化命令评论代码的代码(如此处所述:http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#structuralcommands)。基本上,所有文档都只包含在文件的开头。使用结构化命令(doxygen)记录枚举

不是这种方法的粉丝,但它似乎大部分工作,除了是枚举。这是一个如何记录枚举的例子。

/*! 
    \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能够识别enum及其所有值,但忽略了值的描述。有人可以告诉我使用结构化命令记录枚举的正确方法是什么? (我希望能够避免将所有这些更改为在文档之前或之后放置文档的格式)。

+0

这似乎在使用Doxygen 1.8.3.1做工精细。你用什么版本的Doxygen?你使用的是默认的Doxygen配置文件吗?你能否提供你所看到的输出的屏幕截图? – DRH 2013-05-02 05:35:33

回答

0

尝试:

\var MyEnum EnumValue1 

Description of value.