Doxygen:在struct之外记录struct成员

时间:2015-03-25 19:17:04

标签: c++ doxygen

我知道我可以用doxygen记录结构中的struct成员变量:

struct myStruct {
  int a;   ///< a is an int
}

但是如何将文档放在struct之外呢?我尝试了各种组合,例如:

/// myStruct::a a is an int
/// \var a is an int

但似乎没有一个出现在生成的HTML中。这甚至可能吗?什么是正确的语法?

2 个答案:

答案 0 :(得分:1)

使用 \ brief ,但需要取消注释第一个 \ brief 描述

struct myStruct {
   int a;   // a is an int
}

然后

/// \var int myStruct::a
/// \brief a is an int

我认为&#34;公共属性&#34;用于提供简要信息,而会员数据文档&#34;是为了细节。

确保只有一个 \ brief ,然后外面的文档可以显示在&#34;公共属性&#34;

答案 1 :(得分:0)

以下似乎有效:

/// \var int myStruct::a
/// a is an int

这种方法的问题在于它创建了多个行注释,这些注释显示在“成员数据文档”下,而不是在“公共属性”下,如单行注释,而且还需要复制定义,这很容易出错。

我仍然愿意接受其他更好的答案......