Doxygen链接到const函数

时间:2010-08-22 11:46:09

标签: c++ const doxygen

我有以下功能原型:

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(枚举键)和@copydoc行中删除 const ,它就会起作用。

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

1 个答案:

答案 0 :(得分:2)

/// @copydoc key_pressed(enum key) const

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