CODEWITHSUNDEEP
doxygen
Emilio Garavaglia
Emilio Garavaglia

Reputation: 20759

Multiple Doxygen \relatedalso

Let's say we have

class A
{ ... };

class B
{ ... };

class C
{ ... };

and let's say we have a free-function like

C operator*(A, B)
{ .... }

Is there a way to make operator* to appear in the related functions section of all A, B and C ?

I tried \relatedalso, but it seem to work only once.

Upvotes: 2

Views: 222

Answers (1)

ollo
ollo

Reputation: 25370

Where did you place \relatedalso - documentation of the class(es) or the operator?

You can insert \relates for eacht class at your operators documentation:

/** This is class A. */
class A
{
    // ...
};

/** This is class B. */
class B
{
    // ...
};

/** This is class C. */
class C
{
    // ...
};


/**
 * This is an operator.
 * 
 * \relates A
 * \relates B
 * \relates C
 * 
 * @param a     Class A
 * @param b     Class B
 * @return      Something
 */
C operator*(A a, B b)
{
    // ...
}

Doxygen (html):

Related Functions

(Note that these are not member functions.)
C   operator* (A a, B b)

(operator* is linked to it's documentation)

Upvotes: 1

Related Questions