如何将非成员函数与Doxygen中的类相关联?

时间:2009-11-02 14:21:16

标签: c++ doxygen

我确信使用\ defgroup,\ addgroup和\ @ {\ @}标签有一些方法可以做到这一点,但经过几个小时的试用和(显然)错误,我问的是...... ...

我有:

class C {
public:
    void foo () const;
};

我有一些辅助非成员函数,它们实际上是C接口的一部分,但不在类中:

std::string
format (const C& c, const std::string &fmt);

我希望格式化函数与类函数出现在同一页面上。那是不可能的吗?是最好的我可以做一个“模块”页面,它将C列为一个类(带有C的注释的超链接,格式为函数?

2 个答案:

答案 0 :(得分:13)

\relates(或\ memberof)似乎就是你要找的东西。

答案 1 :(得分:0)

在该组中创建一个组并在类外部分配函数将起作用,但在类文档本身中,除非使用@see或{{1}之类的命令,否则不会获得对函数的引用}}。老实说,因为函数采用文档化参数并不意味着此函数自动成为库的一部分,但您可以使用@sa@defgroup将类和函数链接在一起。