c++ - 用于记录具有可变参数的重载函数的 Doxygen

标签 c++ doxygen variadic-functions overloading

是否可以让 doxygen 为这样的代码创建适当的文档:

void Print(const char* pszFormat, ...);
void Print(const wchar_t* pszFormat, ...);

这段代码有两个问题。首先,我不能从代码的其他部分引用这两个函数。 对于 \ref Print(const char*, ...);\ref Print(const wchar_t*, ...); 仅链接到上述声明之一生成。

变量参数也以必须描述的预定义格式放置。尝试使用 '\param' 标签会导致在函数声明中找不到参数的警告。由于我有多个这样的功能,如果可能的话,我想摆脱专门针对这种情况的警告。

提前致谢。

最佳答案

如果您按字面意思将参数指定为...,它将被 Doxygen 获取。例如。如下:\param[in] ... 格式规范的参数。这将正确显示在您生成的文档中。

虽然没有关于 const char*const wchar_t* 消歧的线索。

关于c++ - 用于记录具有可变参数的重载函数的 Doxygen,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/23867708/

相关文章:

c++ - 只有当我们有多个线程时才会出现不可重入问题吗?

github - 我可以将 GitHub Pages index.html 放在存储库的子文件夹中吗?

Qt 文档标准

java - 为什么从另一个泛型方法调用的泛型可变参数方法会返回 Object[]?

c++ - 关于错误类

c++ - 在C++ v6和VS2010 C++缓冲区问题中编译WAVE声音

c - __cdecl 参数 "..."和 __VA_ARGS__

c - va-args 没有正确解析

c++ - 可以传递匿名变量的地址吗?

Doxygen 相关页面