一次doxygen的注释多个变量 [英] doxygen comment multiple variables at once

问题描述

如果我有以下几点：

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

这只会产生X中的文件，是否有可能在doxygen的得到它评论所有的x，y和z一个评论？

It will only generate that documentation for x, is it possible in doxygen to get it to comment all x, y and z with one comment?

编辑
继envu的建议，我现在有如下（基于该<一个href=\"http://www.stack.nl/~dimitri/doxygen/grouping.html#memgroup\">http://www.stack.nl/~dimitri/doxygen/grouping.html#memgroup)

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

或

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

不过，这些仍然只是文件x的两者。
用不同的形式，我还没有得到相同的文档字符串可以跨越多个变量尝试它

However both of these still only document x. Trying it with different forms I have yet to get the same documentation string to span multiple variables

推荐答案

我会使用的成员组的<一个href=\"http://www.stack.nl/~dimitri/doxygen/grouping.html#memgroup\">http://www.stack.nl/~dimitri/doxygen/grouping.html#memgroup为了这。语法和输出是你想达到什么有点不同，但我认为不应该受到伤害。

I would use member groups http://www.stack.nl/~dimitri/doxygen/grouping.html#memgroup for this. The syntax and output is a little bit different to what you want to achieve, but I think that shouldn't hurt.

这篇关于一次doxygen的注释多个变量的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！