doxygenを使用して、構造体定義外のc構造体のメンバーを文書化します

Question

私はdoxygenを使用してCコードにコメントしています。ドキュメントが不足している外部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... */

正しいdoxygen出力を取得するために@???の代わりにどのタグを使用しますか（「correct」はmystructとforeignstructの生成された出力が同じであることを意味します）？

doxygen · Accepted Answer

たぶん、いつの日か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... */