Как документировать нетипичные параметры шаблона C ++?

Question

Существуют ли какие-либо рекомендации относительно того, как параметры шаблонных шаблонов C ++ должны документироваться с помощью Doxygen?

Например, как мы должны комментировать параметр шаблона нетипичных типов Size в классе Test?

template<int Size>
class Test { };

Я попробовал такое объявление:

/// \tparam Size

Но оно выдает следующее предупреждение:

"'\ tparam' команда, используемая в комментарии, которыйне присоединен к объявлению шаблона [-Wdocumentation] ".

Answer 1

Я использую комментарии в стиле JavaDoc в своем коде. Я проверил с этим:

/**
 * This is my test.
 *
 * @param Size Interesting
 */
template <int Size>
class Test {
};

И это произвело:

Detailed Description

template<int Size>
class Test< Size >

This is my test.

Parameters
Size    Interesting