c++ - 我如何找到对具有复杂签名的事物的正确 doxygen 引用？

Question

我正在记录一些带有模板重载的函数，并希望引用特定的重载。但是我不知道如何为 \ref 命令输入签名才能理解；不幸的是，它需要一个规范版本，我不知道。有没有办法获取 doxygen 生成的规范签名列表？

我的具体情况是这样声明的函数:

template <typename T, size_t S>
int function(T value, Table const (&descriptors)[S]);

我试过了

\ref function(T,Table(&)[])
\ref function<>(T,Table(&)[])
\ref function(T,const Table(&)[])
\ref function<>(T,const Table(&)[])
\ref function(T,Table const(&)[])
\ref function<>(T,Table const(&)[])

我也尝试过不使用 \ref(它应该会自动注意到符号)，但这也好不到哪儿去。

或者有自己定义引用的方法吗？

我也试过在目标函数文档中定义 anchor ，但它指向描述主体而不是函数应该引用的标题。

Answer 1

doxygen 中的一个错误阻止了@ref'ing 类型包含大括号的参数。我刚刚 committed GitHub 的可能解决方案。让我知道这是否适合您。

我用下面的例子自己测试了一下:

/** @file */

/** complex function */
template <typename T, size_t S>
int function(T value, Table const (&descriptors)[S]);

/** @mainpage
 *  See @ref function(T,Table const (&)[S]) "complex function" for details.
 */