CODEWITHSUNDEEP
javadocdoxygendocumentation-generation
Roberto
Roberto

Reputation: 11933

Is there an @inheritDoc equivalent in Doxygen?

I know Javadoc will compile {@inheritDoc}, but what's the Doxygen way to do this?

Upvotes: 17

Views: 14355

Answers (2)

Conrad Poelman
Conrad Poelman

Reputation: 862

With INHERIT_DOCS set to YES in your Doxygen configuration file (which is actually the default), just leave your overridden members completely uncommented and Doxygen will automatically insert the documentation from the base class.

@copydoc is useful for the case where you want to inherit base class comments, but then add some subclass-specific details.

Upvotes: 16

Andy Dent
Andy Dent

Reputation: 17969

There's the explicit copydoc which I think is closest to an equivalent although with more flexibility it therefore requires you specify the original to copy so is a bit more awkward. It's designed to let you pull in documentation from anywhere so it needs a parameter specifying the source.

By default, the default is to inherit documentation from parent classes.

Upvotes: 16

Related Questions