如何在Doxygen中将非成员函数与类关联？

Question

我相信通过使用 \defgroup、\addgroup 和 \@{ \@} 标签有一种方法可以实现这个，但是经过几个小时的尝试和（显然）错误之后，我向 SO 提问......

我有：

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

而我有一些辅助的非成员函数，它们确实是C++接口的一部分，但并不在类中：

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

我希望将 format 函数显示在与类函数相同的页面上。这是否不可能？最好的办法是创建一个“模块”页面，其中将 C 列出为一个类（带有指向 C 评论和 format 函数的超链接）吗？

- Eric H.

Answer 1

\relates（或\memberof）似乎是您要查找的内容。

- Éric Malenfant

---

嗯...是的...现在我感觉错过了那个，感觉自己像个白痴。我想我需要重新阅读文档中的特殊命令部分。我不记得在示例中看到过\relates的使用。 - Eric H.

Answer 2

创建一个组并在该组中分配类外函数是可行的，但在类自身的文档中，除非您使用像@see或@sa这样的命令，否则您不会得到有关您的函数的参考。 老实说，因为一个函数需要一个已记录的参数，并不意味着这个函数自动成为库的一部分，但您可以使用@defgroup和@addgroup将两个类和函数链接在一起。

- Percutio

---

如果函数与类定义在同一个头文件中，那么它很可能应该在文档中与类一起介绍。可以参考Herb Sutter对“公共接口”的定义。 - Matthieu M.

正如Matthieu所说......这是界面的一部分。这就是为什么我想知道是否有办法让它们显示在同一页上。 - Eric H.