Doxygen 枚举未显示答案

【问题标题】：Doxygen enum not showingDoxygen 枚举未显示
【发布时间】：2013-12-24 19:16:30
【问题描述】：

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

【问题讨论】：

【解决方案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 */
};

希望对你有帮助

【讨论】：

谢谢！ \file 指令在哪里？任何一个小例子的机会， eps 用于内联声明的枚举。（即在类头的顶部声明）。
谢谢 - 这很有帮助。但是，它不起作用 - 添加文件标签和简介没有效果。 .但是，我修改了我的 Doxyfile 以包含 SHOW_FILES = YES，然后简单地在枚举中添加了一个 doc-tag。

【解决方案2】：

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

SHOW_FILES = YES

。 .然后只需将标准文档-cmets 添加到枚举类型。

现在是linked and documented。

【讨论】：