[Doxygen-users] documenting friend functions

[Rod O. <oll...@SE...>]

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?

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 );
}

and in a another .h file the stream operator is defined

inline ostream& operator<<(
        ostream& stream,
        const MsgId& obj )
{
    ....
}