c++ - Doxygen 链接到 const 函数

标签 c++ constants doxygen

我有以下函数原型(prototype):

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 命令中正确指定了修饰符?

最佳答案

/// @copydoc key_pressed(enum key) const

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

关于c++ - Doxygen 链接到 const 函数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/3541353/

相关文章:

c++ - CMake:创建二进制 foo + 库 libfoo?

java - 关于并行的接口(interface)声明

markdown - doxygen markdown 围栏代码块与缩进列表冲突

doxygen - 为具有简单类型成员的结构生成协作图

c++ - 如何刷新 cin 缓冲区?

c++ - 哪个值更好用? boolean 真还是整数 1?

java - 在 kotlin 类中创建 "public"常量

xml - 如何让 Doxygen 在包含 XML 片段的@code 中进行语法高亮显示?

c++ - 错误 C2143 : syntax error : missing '{' before '*'

c++ - 如何将 const char* 转换为字符串,然后再转换回 char*?