Doxygen документ C++ шаблоны классов

Question

Im пытается документировать следующее:

template <class T, int NDim> 
class myClass { 

public: 
. 
. 

вот Doxygen

/*! 
* \class myClass<T, NDim> 
* \brief Defines a class for stuff. 
*/ 

урожайность поколения:

MyClass класса Reference

Определяет класс для вещей.

Так что мне не хватает информации о шаблоне, но это не конец света, так как я знаю, что doxygen не имеет дело с шаблонами. Основные проблемы, это предупреждение при генерации:

myClass.h: 2: предупреждение: имя `Т» поставляется в качестве аргумента \ класса, \ STRUCT, \ союз, или \ включают в себя команду не входной файл

Как я могу устранить это предупреждение?

Answer 1

AFAIK это не нужно указывать \class явно, Doxygen должен определить имя класса автоматически, если вы поставите документацию непосредственно перед шаблонным классом декларации

/** << NOTE 
* \brief Defines a class for stuff. 
* \tparam T Type to work with. 
* \tparam NDim Number of dimensions. 
*/ 
template <class T, int NDim> 
class myClass { 

public: 
. 
. 
}; 

Чтобы указать документацию для параметров шаблона используйте \tparam.

Также примечание: использование < и > будет интерпретироваться как встроенные теги HTML от doxygen. Вместо этого используйте \< и \>.