doxygen文档c ++类模板

Question

我正在尝试记录以下内容：

template <class T, int NDim>
class myClass {

public:
.
.

这是氧气

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

发电量：

myClass类参考

定义东西的类。

因此，我缺少模板信息，但这并不是世界末日，因为我知道doxygen不能很好地处理模板。主要问题是生成期间的警告：

myClass.h：2：警告：作为\ class，\ struct，\ union或\ include命令的参数提供的名称“ T”不是输入文件

我该如何解决此警告？

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。

另请注意：的用法<和>doxygen将解释为内联HTML标签。使用\<和\>代替。