Is there an @inheritDoc equivalent in Doxygen?

javadoc doxygen documentation-generation
Roberto picture Roberto · Apr 4, 2011 · Viewed 9.3k times · Source

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

Answer

Conrad Poelman picture Conrad Poelman · Mar 21, 2015

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.

Related questions

How to reference a method in javadoc?

How can I use the @link tag to link to a method? I want to change: /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return …

Read More
How can I generate Javadoc comments in Eclipse?

Is there a way to generate Javadoc comments in Eclipse? If so, what is it?

Read More
How to generate Javadoc HTML files in Eclipse?

I have written Javadoc style comments like this in my project's code: /** * Description... * * @param ... * @return ..... */ How can I generate Javadoc HTML files using the Eclipse IDE?

Read More