如何找到具有复杂签名的正确的doxygen参考?

时间:2013-09-04 13:07:18

标签: c++ doxygen

我正在使用模板重载记录一些函数,并希望引用特定的重载。但我不知道如何输入\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(它应该自动注意到符号),但那并没有更好。

或者是否有方式自行定义引用?

我也尝试在目标函数文档中定义锚点,但是指向描述主体而不是标题作为函数的引用应该。

1 个答案:

答案 0 :(得分:2)

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.
 */