[Doxygen-develop] Re: [Doxygen-users] Avoiding repeated documentation on inherited members?

[Dimitri v. H. <di...@st...>]

On Wed, Aug 07, 2002 at 10:02:25AM +0200, Morten Eriksen wrote:
> Hi,
> 
> I wondering if it's possible to configure Doxygen to _not_ repeat the
> documentation on C++ inherited members of subclasses?
> 
> IMHO, this feature tends to clutter up the API documentation more than
> it clarifies -- at least for the particular class library I'm
> documenting.
> 
> An example to make myself clear:
> 
> ----8<--- [snip] ---------8<--- [snip] ---------8<--- [snip] -----
> 
> //! This class blablabla...
> class Super {
> public:
>         //! This method blablabla...
>         virtual void aVirtualMethod(void);
> };
> 
> //! This class blablabla...
> class Sub : class Super {
> public:
>         virtual void aVirtualMethod(void);
> };
> 
> ----8<--- [snip] ---------8<--- [snip] ---------8<--- [snip] -----
> 
> Now, for class Sub, aVirtualMethod() will be included in the
> documentation, just repeating the documentation of this method in the
> Super class. I would like to avoid that, to "clean up" and remove
> unnecessary clutter in a huge, fine-grained class library I have
> documented here. This library has deeply nested class inheritance
> hierarchies, with many virtual methods like that above primarily used
> internally in the library implementation. Having the method
> documentation repeated for each subclass which overrides the virtual
> method of the superclass therefore just generates "noise".
> 
> So, is there any way to accomplish this -- ie don't include overridden
> methods in the output _if_ they just use the doc of the same method in
> the superclass?

INHERIT_DOCS = NO should do that if I understand you correctly.

Regards,
  Dimitri