doxygen 文档 c++ 类模板

Question

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

template <class T, int NDim>
class myClass {

public:
.
.

这里是doxygen

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

发电量：

myClass 类参考

为东西定义一个类。

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

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

我该如何解决这个警告？

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 标签。请改用\< 和\>。