使用Doxygen不记录变量

时间:2012-02-19 17:29:24

标签: variables attributes doxygen

我正在使用Doxygen来记录我的C ++代码。所有都以HTML格式输出,除了下面的属性/变量不是(根本不是)。

    /**
     * Flag to check whether the variable is once initialized or not
     */
     bool initialized_;

知道可能出现什么问题吗?

修改

initialized_是一个类成员变量。

2 个答案:

答案 0 :(得分:2)

我不确定这是否能解决你的问题,因为你提供的关于变量initialized_的信息很少(它是一个全局变量,它是类的一部分等),但doxygen { {3}}(请参阅其他地方的文档标题下)

  

要记录C ++类的成员,还必须记录该类本身。名称空间也是如此。要记录全局C函数,typedef,enum或预处理器定义,必须首先记录包含它的文件(通常这将是一个头文件,因为该文件包含导出到其他源文件的信息)。

     

让我们重复一遍,因为它经常被忽视:要记录全局对象(函数,typedef,枚举,宏等),您必须记录定义它们的文件。换句话说,至少必须有一个

/*! \file */ 
     

/** @file */ 
     

此文件中的行。

答案 1 :(得分:0)

这也可能有助于人们寻找答案:

# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.

RECURSIVE              = YES

在您的 Doxyfile 文件中

我正在使用 doxygen 和 OS X 的 Doxygen GUI 前端 (Doxywizard) 版本 1.8.9.1。还有一个用于递归扫描的复选框,您可以启用。默认情况下未启用此功能。

./doxygen -x
error: Unknown option "-x"