Template or function arguments as implementation details in doxygen?
Posted
by
Vincent
on Stack Overflow
See other posts from Stack Overflow
or by Vincent
Published on 2012-09-15T02:41:40Z
Indexed on
2012/09/15
3:38 UTC
Read the original article
Hit count: 147
In doxygen is there any common way to specify that some C++ template parameters of function parameters are implementation details and should not be specified by the user ?
For example, a template parameter used as recursion level counter in metaprogramming technique or a SFINAE parameter in a function ?
For example :
/// \brief Do something
/// \tparam MyFlag A flag...
/// \tparam Limit Recursion limit
/// \tparam Current Recursion level counter. SHOULD NOT BE EXPLICITELY SPECIFIED !!!
template<bool MyFlag, unsigned int Limit, unsigned int Current = 0> myFunction();
Is there any doxygen normalized option equivalent to "SHOULD NOT BE EXPLICITELY SPECIFIED !!!" ?
© Stack Overflow or respective owner