使用Doxygen不记录变量

问题描述 投票:0回答:1

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

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

什么可能出错?

编辑

initialized_是一个类成员变量。

variables attributes doxygen
1个回答
2
投票

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

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

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

/*! \file */ 

或者a

/** @file */ 

该文件中的行。

© www.soinside.com 2019 - 2024. All rights reserved.