C ++テンプレートとテンプレートメタ関数をDoxygenで文書化する方法に関するガイドラインはありますか?
例えば:
/// @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;
};
これまでのところ、私は次の提案を見てきました。
@tparam
テンプレートパラメータを文書化するために使用されます。@arg
テンプレートパラメータを文書化する別の方法。@brief
メタ関数を説明するために使用されます。
メタ関数の「返されたタイプ」はどのように文書化する必要がありますか?
C ++テンプレートでDoxygenを使用するための良い提案や個人的な好みはありますか?