如何用氧气记录朋友注射功能

How to document friend injection functionality with doxygen?

本文关键字：功能 朋友 记录 何用 氧气      更新时间：2023-10-16

给出如下示例中的代码:

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

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

在现实世界中的一个有用的例子:我希望氧包含由boost/operators.hpp中的基类提供的操作符。

/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

相关文章：