doxygen - 多个 Doxygen \relatedalso

Question

假设我们有

class A
{ ... };

class B
{ ... };

class C
{ ... };

假设我们有一个自由功能

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

有没有办法让它operator*出现在所有 A、B 和 C 的相关功能部分？

我试过\relatedalso了，但它似乎只工作一次。

Answer 1

你在哪里放置\relatedalso- 类或操作员的文档？

您可以\relates在操作员文档中为 eacht 类插入：

/** 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)
{
    // ...
}

氧气（html）：

Related Functions

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

（operator*链接到它的文档）