c++ - Doxygen 生成的文档中显示了静态函数的模板特化

标签 c++ templates doxygen template-specialization

在我的项目的 C++ header 中,我使用了一些在非静态公共(public)函数中调用的静态模板函数帮助器。

当我在此文件上运行 Doxygen 时,即使使用模板,每个静态函数也会被隐藏,这是正确的行为,因为静态函数对外部世界不可见。但是,当我对其中之一进行模板特化时,该特化将出现在生成的文档中:

// This will not appear in documentation, ok
template<class T>
static T my_function(...)

// However this will appear ! :(
template<>
SomeClass my_function(...)

如果认为这是因为 Doxygen 不够聪明,无法看到此专门化是针对静态函数的,因此此专门化看起来像常规函数。但也许我错了。

如何才能在我的文档中隐藏此内容?

最佳答案

始终可以在代码周围使用 @cond@endcond 从 Doxygen 隐藏代码部分。

它相当于 doxygen #if 0/#endif

关于c++ - Doxygen 生成的文档中显示了静态函数的模板特化,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/20979469/

相关文章:

python - Python 的 Doxygen : one paragraph to document both file and package

c++ - 我如何记录以便文档适用于类成员而不是匿名类型?

c++ - 如何有效地选择符合特定条件的 QTableView 行的子集?

c++ - 如何在结构中的指针上使用 cudaMalloc?

C++ 在派生类中重载模板函数

c++ - 模板。参数包扩展 - 重新映射类型

c++ - 在运行时选择正确的模板特化

c - Doxygen 转义 C 中的嵌套注释

c++ - 什么是数组指针,int (*ptr)[10],它是如何工作的?

c++ - 错误 LNK2019 C++ 难以忍受的简单程序