Re: [Doxygen-users] documenting friend functions

[Luigi B. <lui...@ri...>]

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