使用双氧键在结构定义之外记录c结构的成员

Question

我正在使用doxygen注释我的C代码。我使用的是外部API（即不是我自己的API），但缺少相关文档，因此我打算在自己的源文件中记录一些该API。我do具有用于外部API的头文件，但是将我自己的注释添加到该文件是不现实的。

外国标题

struct foreignstruct
{
    int a;
    int b;
};

我的标题

/** My structure comments... */
struct mystruct
{
    /** Describe field here... */
    int field;
};

/** @struct foreignstruct
 *  @brief This structure blah blah blah...
 *  @??? a Member 'a' contains...
 *  @??? b Member 'b' contains...
 */

[我用什么标签代替@???以获得正确的氧气输出（其中“正确”表示mystruct和foreignstruct的生成输出是相同的？]

Answer 1

也许有一天，doxygen将为此使用特殊的@field标签，直到那时为止，可以使用以下命令：

/** @struct foreignstruct
 *  @brief This structure blah blah blah...
 *  @var foreignstruct::a 
 *  Member 'a' contains...
 *  @var foreignstruct::b 
 *  Member 'b' contains...
 */

这是]的简写形式>

/** @struct foreignstruct
 *  @brief This structure blah blah blah...
 */
/** @var foreignstruct::a 
 *  Member 'a' contains...
 */
/** @var foreignstruct::b 
 *  Member 'b' contains...
 */