Doxygen INHERIT_DOCUMENTATION,只覆盖一个参数

时间:2014-03-19 19:49:38

标签: c++ inheritance doxygen

我仍然没有决定是否使用INHERIT_DOCUMENTATION是一个好主意,因为你不再在代码中有文档...但是,我想知道我是否可以用INHERIT_DOCUMENTATION做这样的事情(我是喜欢以面具的方式工作)

class iA
{
public:
  ///
  ///@brief Base message that every one has
  ///@param bar something something something
  ///@return Confidence interval (see specific implementation for more information)
  ///
  virtual double foo(int bar) = 0;
};

class B : public iA
{
public:
//inherit the full parent message, but override just the return statement

///
///@return Confidence interval, which is just equal to bar
///
virtual double foo(int bar) {return bar;}
};

所以关于B :: foo的有效说明是:

  ///
  ///@brief Base message that every one has
  ///@param bar something something something
  ///@return Confidence interval, which is just equal to bar
  ///

可以这样做吗?

0 个答案:

没有答案