Doxygen enum没有显示

Question

是否可以为我的一个类标题上声明的枚举使用doxygen生成文档？ this link中名为“范围”的属性的枚举未显示为文档类型。

Answer 1

根据Doxygen手册here：

To document global objects (functions, typedefs, enum, macros, etc), you must document the file in which they are defined. In other words, there must at least be a

/*! \file */ 
or a
/** @file */ 
line in this file.

以下是一个例子：

/*! \file MyClass.h
    \brief A brief file description.

    More details
 */

/*! This is an enum */
enum Direction {
    kDirectionRight, /*!< this is right */
    kDirectionLeft,  /*!< this is left */
};

希望这有帮助

Answer 2

编辑您的Doxyfile配置并设置以下内容：

SHOW_FILES = YES

。 。然后只需将标准文档注释添加到枚举类型。

现在是linked and documented。