Re: [Doxygen-users] (no subject)

[Phil L. <plo...@sa...>]

I just found @copydoc, so I think I answered my own question

Phil Longstaff
Senior Software Engineer
Direct: 519-880-2400 ext 2904
www.sandvine.com<http://www.sandvine.com>
From: Phil Longstaff [mailto:plo...@sa...]
Sent: Wednesday, October 20, 2010 9:04 AM
To: 'dox...@li...'
Subject: [Doxygen-users] (no subject)

I'm in the process of writing some doxygen documentation and I'm curious about support for inheriting documentation. For example, suppose you have a base class that provides unimplemented, pure-virtual methods. These can and should be fully documented. For the most part, the @brief, @param, and @return documentation can simply be copy pasted (or inherited) from the base class' documentation into the derived class. The derived class may then add some additional documentation as well, but I'm wondering if there's a doxygen feature that allows this documentation to be inherited, so that things can by kept in-sync and sufficiently up to date.
If there isn't, then maybe @overrides would be a useful addition so that both the pure virtual base class method and the derived class method would have all of the parameters and return value included in the documentation, but the actual function documentation could be different.

Phil Longstaff
Senior Software Engineer
Direct: 519-880-2400 ext 2904
www.sandvine.com<http://www.sandvine.com>