doxygen中的函数类型参数

时间:2013-12-05 02:28:00

标签: c++ doxygen

由于某些原因,Doxygen似乎没有正确显示参数,如果它具有函数类型:

/// Brief...
/// 
/// Details...
void x(int f(int, int));

在功能列表中,它显示正确,但在x的详细条目中,参数f显示为:

int fint, int   

代替。有办法解决这个问题吗?

1 个答案:

答案 0 :(得分:1)

也许这主要不是Doxygen问题。您的声明不如源中使用的那么好,我更喜欢typedef

namespace MyNamespace
{
/**
 * Type alias \c F for function signature: \code int (*)(int, int) \endcode
 */
typedef int (*F)(int, int);

和函数声明

/**
 * Function using \em fnPtr with function pointer alias signature 
 * \c MyNamespace::F.
 * @param fnPtr A callback function pointer with alias signature 
 *              \c MyNamespace::F.
 */
void x(F fnPtr);
} // close MyNamespace scope

生成的Doxygen文档相应地看起来正确恕我直言:

Generated Documentation Screenshot