多个Doxygen \ relatedsoso

时间:2013-05-07 13:37:40

标签: doxygen

假设我们有

class A
{ ... };

class B
{ ... };

class C
{ ... };

让我们说我们有一个像

这样的自由功能
C operator*(A, B)
{ .... }

有没有办法让operator*出现在所有A,B和C的相关函数部分?

我尝试\relatedalso,但它似乎只运行一次。

1 个答案:

答案 0 :(得分:1)

您在哪里放置\relatedalso - 班级文件或操作员?

您可以在运营商文档中为每个类插入\relates

/** 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*与其文档相关联)