当类型定义类型时,Doxygen不记录变量

时间:2014-02-24 20:52:15

标签: c doxygen

我有一个名为“myfile.c”的文件。在这个文件的顶部,我有一个文档块

/*!
* \file myfile.c
* \ingroup mygroup
* \defgroup mygroup This is the foo module
* \brief Module containing foo code
*/

在该文件中,我有以下内容:

/*!
* \brief blabla
* \ingroup mygroup
*/
typedef struct
{
    uint8_t foo1, foo2, foo3;
} mytype_t

此结构的文档显示在mygroup的doxygen输出中。但是,当我创建mytype_t类型的变量时,不会输出其文档。

/*!
* \brief blabla
* \ingroup mygroup
*/
static mytype_t volatile my_variable=
{
    .foo1 = 1u,
    .foo2 = 2u,
    .foo3 = 3u
};

我尝试添加标记

\var my_variable

这似乎没有做任何事情。

我错过了什么吗?

my_variable的文档不仅仅是从组中丢失 - 它根本不存在于我的doxygen输出中。此外,我的输出日志中没有任何内容与我的变量名称 - 警告,错误或其他。

1 个答案:

答案 0 :(得分:0)

嗯,我很傻。那些变量是静态的,我没有将EXTRACT_STATIC SET设置为是。