使用doxygen来记录结构定义之外的ac结构的成员
我正在使用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
生成输出是相同的)?
也许有一天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... */