Jas*_*ues 8 c doxygen objective-c
是否可以为我的一个类头上声明的枚举使用doxygen生成文档?此链接中名为"scope"的属性的枚举未显示为文档类型.
根据此处的Doxygen 手册:
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.
Run Code Online (Sandbox Code Playgroud)
下面是一个例子:
/*! \file MyClass.h
\brief A brief file description.
More details
*/
/*! This is an enum */
enum Direction {
kDirectionRight, /*!< this is right */
kDirectionLeft, /*!< this is left */
};
Run Code Online (Sandbox Code Playgroud)
希望这可以帮助
编辑您的 Doxyfile 配置并设置以下内容:
SHOW_FILES = YES
Run Code Online (Sandbox Code Playgroud)
。。然后只需将标准文档注释添加到枚举类型即可。
现在将对其进行链接和记录。