Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Will doxygen use base class docs if a sub-class doesn't provide its own?

Tags:

doxygen

If I have a class:

class Base
{
 public:
  ///does something
  virtual void method()=0;
};
class Child : public Base
{
 public:
  virtual void method();
};

What will doxygen do for Child::method? Reuse the base docs, or leave it blank?

like image 216
Mr. Boy Avatar asked Jun 30 '11 12:06

Mr. Boy


1 Answers

This depends on the INHERIT_DOCS configuration setting. When setting INHERIT_DOCS to YES the documentation will be copied, when setting it to NO the derived method will remain undocumented.

like image 91
doxygen Avatar answered Jan 10 '23 09:01

doxygen