Doxygen-genered文档中显示了静态函数的模板特化

时间:2014-01-07 18:51:49

标签: c++ templates doxygen template-specialization

在我的项目的C ++标题中,我使用了很少的静态模板函数助手,这些助手在非静态公共函数中调用。

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

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

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

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

如果要将其隐藏在我的文档中,我该怎么办?

1 个答案:

答案 0 :(得分:1)

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

这是与#if 0 / #endif

等效的doxygen