繁体   English   中英

如何使用doxygen记录朋友注入功能?

[英]How to document friend injection functionality with doxygen?

给出一些代码,如下例所示:

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基类提供的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

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM