c - 使用 doxygen 记录结构定义之外的 c 结构成员

Question

我正在使用 doxygen 来注释我的 C 代码。我正在使用一个文档很少的外国 API(即不是我自己的 API)，因此我打算在我自己的源文件中记录其中的一些 API。我确实有外国 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...
 */

我使用什么标签代替 @??? 来获得正确的 doxygen 输出(其中“正确”表示为 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...
 */