Are there any guidelines on how C++ templates and template meta-functions should be documented with Doxygen?
For example:
/// @brief metafunction for generation of a map of message types to
/// their associated callbacks.
/// @tparam Seq the list of message types
template< class Seq >
struct generate_callback_map
{
typedef typename mpl::transform< Seq
, build_type_signature_pair< mpl::_1 >
>::type vector_pair_type;
typedef typename fusion::result_of::as_map< vector_pair_type >::type type;
};
So far I have seen the following suggestions:
@tparam
used to document template parameters.@arg
alternative way of documenting template parameters.@brief
used to describe the metafunction.
How should the 'returned type' for the metafunction be documented?
Does anyone have any good suggestions or personal preferences for using Doxygen with C++ templates?