2012-02-19 95 views
0

我使用Doxygen来记录我的C++代码。所有的都以HTML格式输出,除了像下面这样的属性/变量不是(完全没有)。变量没有记录使用Doxygen

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

任何想法可能出错?

EDIT

initialized_是一个类的成员变量。

回答

2

我不确定这是否能解决您的问题,因为您已经提供了关于变量initialized_(它是一个全局变量,它是否为类的一部分等)的很少信息,但doxygen documentation(参见下在其他地方)标题文档指出

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

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

/*! \file */ 

/** @file */ 

线。

+0

你的意思是应该在标题(界面)或我的实现文件中包含此行。它仍然没有打印。 – 2012-02-20 16:01:17

+0

该文档非常清晰:如果该变量是全局对象,则其定义的文件必须记录(使用'\ file')。如果变量是类的成员,则该类本身必须定义。既然你更新了你的问题,所以声明'initialised_'是一个类成员,你记录了那个类吗? – Chris 2012-02-20 18:33:38

+0

你的意思是在课前声明之前,我通过把'@ brief','@ param'等文件记录下来?如果你的意思是,我已经做到了。 – 2012-02-20 19:29:44