c++ - 如何使用 doxygen 记录好友注入(inject)功能？

Question

给定如下示例中的一些代码:

class MyClass;

class Injector {
    /**
     * @brief MyClass addition.
     */
    friend MyClass operator+(MyClass a, MyClass b) { ... }
};

class MyClass: private Injector {};

如何让doxygen在MyClass类的文档页面包含operator+()的文档？从功能上讲，它显然属于那里。是否有一些通用方法可以通过 ADL 提供 doxygen 文档功能？

现实世界中的一个有用示例:我希望 doxygen 包含 boost/operators.hpp 中的基类提供的运算符。

Answer 1

/relates 标签就是为类似的东西而设计的。

class MyClass;

class Injector {
    /**
     * @brief MyClass addition.
     * @relates MyClass
     */
    friend MyClass operator+(MyClass a, MyClass b) { ... }
};

class MyClass {};

这不会将文档放在同一页面，但会在同一页面上生成“相关功能”部分，该部分链接到该功能。

http://www.doxygen.nl/manual/commands.html#cmdrelates