Re: [Doxygen-users] (no subject)

[Bradley W. <br...@wa...>]

You learn so much by following these emails!

 

I was not familiar with the @copydoc command either, so when I saw this
email I immediately went and tried it out. But I have not been able to get
it to work. 

 

When I do the following:

 

@copydoc Fully.Qualified.ClassName

 

I get the following error from Doxygen:

 

Warning: target "Fully.Qualified.ClassName" of \copydoc command not found

 

To test the resolution of the class I am trying to copydoc from, I put the
following:

 

@see Fully.Qualified.ClassName

 

The @see command works fine and generates the link, but the @copydoc command
gives me that warning message and does no copy in the documentation.

 

What am I doing wrong here? Is there some syntax I need to use to copydoc
the comments from the interface class into my implementation class?

 

Also, was something changed in a recent Doxygen release that might affect
this? I am a few releases behind. the last update I did was 4-5 months back.

 

Please advise,


Thanks,

 

Brad

 

My environment: C#

 

From: Phil Longstaff [mailto:plo...@sa...] 
Sent: Wednesday, October 20, 2010 9:42 AM
To: 'dox...@li...'
Subject: Re: [Doxygen-users] (no subject)

 

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

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