RE: [Doxygen-users] documenting friend functions
Brought to you by:
dimitri
|
From: Wagner, V. <VW...@se...> - 2001-05-08 15:47:13
|
I put my friend << and >> inside my classes also so that Doxygen gets them
in the 'right' place in the docs
-----Original Message-----
From: Luigi Ballabio [mailto:lui...@ri...]
Sent: Tuesday, 2001 May 08 12:35
To: dox...@li...;
dox...@li...
Subject: Re: [Doxygen-users] documenting friend functions
At 08:54 AM 5/8/01 -0600, Rod Ollerhead wrote:
>Trying to get documentation for a friend function that is not contained
>within the class it is a friend of. Any ideas? How does doxygen
>understand and document friend classes?
Rod,
the following works for me with the latest Doxygen and a freshly
generated configuration file:
/*! \file blah.cpp
\brief blah
*/
//! blah
class blah {
/*!
* Get a string for debug output.
* @param stream IN The stream to add to
* @param obj IN The message ID to display
* @return The stream with the message ID added
*/
friend ostream& operator<<( ostream& stream, const MsgId& obj );
};
Doxygen puts the operator<< documentation into the "Friends and related
functions" section of class blah. It doesn't even need to see the
operator<< definition in the other file.
Bye,
Luigi
_______________________________________________
Doxygen-users mailing list
Dox...@li...
http://lists.sourceforge.net/lists/listinfo/doxygen-users
This transmission may contain information that is privileged, confidential
and exempt from disclosure under applicable law.
If you are not the intended recipient, you are hereby notified that any
disclosure, copying, distribution, or use of the information contained
herein (including any reliance thereon) is STRICTLY PROHIBITED.
If you received this transmission in error, please immediately contact the
sender and destroy the material in its entirety, whether in electronic or
hard copy format.
Thank you
|