2010-08-22 74 views
0

我已经得到了下面的函数原型:Doxygen的链接const函数

bool key_pressed(enum key key) const; 

我记录它使用的doxygen。现在我有一个功能,做同样的重载版本,所以我想复制这样doxygen的评论:

/// @copydoc key_pressed(enum key) const 
bool key_pressed(char key) const; 

这是不行的,我是从的doxygen收到以下警告:

Warning: target key_pressed(enum key) const of \copydoc command not found 

如果我从key_pressed(enum key)和@copydoc行中删除const,它将起作用。

我是否在我的copydoc命令中正确指定了修饰符?

回答

2
/// @copydoc key_pressed(enum key) const 

这应该不是(enum key key)?不,我会建议使用相同的名称作为输入参数作为枚举名称...

+0

这就是诀窍!奇怪的是,因为Doxygen文档指出参数名称可以省略自动链接!关于命名它一样 - 我不能真正想出有用的替代品。避免这种情况是骆驼符号IMO的一大优点。 – halifar 2010-08-22 12:04:01