Doxygen:记录重载函数

Question

如果我的文档与我的代码分开,我如何帮助Doxygen区分重载函数(在\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命令.请参阅doxygen命令参考.使用常规\ fn命令作为基本情况,并使用\ overload进行任何,即过载.:)

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) { }