如何为具有长类型名称的"C"变量添加Doxygen注释

Question

我有一个代码

   static const guint8 variable;

我放文件的时候

/**
 * \var static const guint8 variable;
 * \brief This is a variable
 */
static const guint8 variable;

我在生成的文档中没有得到任何输出.但是,当使用简单的变量decleration完成相同的操作时:

/**
 * \var int someothervar;
 * \brief This is some other variable
 */
int variable;

它确实有效

是我在使用中犯了一些错误？

在此先感谢您的帮助,

- elechi

Answer 1

要提取静态变量,应将EXTRACT_STATIC设置为YES.

如果文档在变量前面,则不需要(也不应该使用)\ var

将EXTRACT_ALL设置为YES或在代码中添加带有@file命令的注释以记录文件本身.