Question

如果我有以下内容：

/**
 * @brief (x,y,z) points for block
 */
int x, y, z;

它只生成x的文档，是否可以在doxygen中通过一条注释对所有x，y和z进行注释？

EDIT 根据envu的建议，我现在有以下内容（基于http://www.doxygen.nl/manual/grouping.html#memgroup）

//@{
/** some documentation here */
int x, y, z;
//@}

或

//@{
/**
 * @brief some documentation here
 */
int x, y, z;
//@}

然而，这两个仍然只记录x。尝试使用不同的表单我还没有得到相同的文档字符串来跨越多个变量

Answer 1

一直在敲打这个。事实证明，您必须在配置中设置DISTRIBUTE_GROUP_DOC = YES。

Answer 2

我会使用成员组 http://www.doxygen.nl/manual/grouping.html#memgroup。语法和输出与你想要实现的有点不同，但我认为不应该受到伤害。

Answer 3

我意识到这是一个老问题，但我遇到了类似的问题，并找到了一种解决方法，但并未解决问题，但在某些情况下可能是可接受的替代方案。

通过在成员组块上方添加注释并在其前面添加\name装饰器，您将获得一个描述，该描述显示在Doxygen页面的属性列表中成员组中的所有变量之上。我相信这只是一个简短的描述，但如果你愿意，你可以在这里添加任意长的描述。

这不会在成员组中的每个变量的详细信息字段中添加相同的注释（详细信息字段将为空，或者如果您在成员组块中放置注释，它仍然会只适用于第一个变量），但它确实具有将相关变量组记录在一起的效果，这看起来就像问题的原始意图一样。

示例：

/*! \name This will be the description for the following group of variables
          It can be arbitrarily long, but the first line will show up in bold,
          and any subsequent lines will show up like a description under it
*/
//@{
int relatedVariable1;
int relatedVariable2;
char* relatedVariable3;
//@}

Answer 4

我在“专家”标签中设置了“DISTRIBUTE_GROUP_DOC”选项。他们所有成员都收到了同样的评论。

#include <string.h>

void *
 memmem(const void *big, size_t big_len, const void *little,
     size_t little_len);

doxygen一次注释多个变量

4 个答案: