如何为具有长类型名称的“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命令的注释以记录文件本身。