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输出（其中'correct'表示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...
 */

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

1 个答案: