Doxygen enum not showing

2018-06-27 05:04:31

Is it possible to have doxygen generate docs for an enum declared on one of my class headers? The enum for the property called 'scope' in this link is not showing as a documented type.

According to Doxygen manual 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.

Here is an example:

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

    More details
 */

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

Hope this helps

Edit your Doxyfile config and set the following:

SHOW_FILES = YES

. . and then simply add standard document-comments to the enum type.

It will now be linked and documented.

链接地址: http://www.djcxy.com/p/76076.html

上一篇: 将文件夹（SMB）从AWS上的EC2实例共享到远程计算机

下一篇: Doxygen枚举没有显示