氧:记录重载函数

Question

如果我的文档与我的代码分开，我如何帮助氧区分重载函数(在fn字段中使用什么)?单个函数的文档将如下所示:

void func() {
}
/**
    fn func
    details Description here.
  */

如果我有两个叫做func的函数呢?

void func() {
}
void func(int i) {
}
/**
    fn [What goes here?]
    details Description here.
  */

Answer 1

对于这种情况有一个overload氧气命令。请参考doxygen命令参考。对基本情况使用常规的fn命令，对任何重载使用重载。:)

Answer 2

您可以简单地记录每个重载，就好像它是一个单独的方法一样(它确实是:-)—只需将整个方法签名放在fn命令中，而不仅仅是方法的名称。如:

/**
    fn func()
    details Description here.
 */
void func() { }
/**
    fn func(int i)
    details Description here.
 */
void func(int i) { }

(对不起，我只需要将文档注释移动到方法上面它们所属的位置:-)

实际上，如果注释直接位于它所属的代码元素的前面，则根本不需要fn命令。

/**
    details Description here.
 */
void func() { }
/**
    details Description here.
 */
void func(int i) { }