我试图记录以下内容:
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&#39;提供作为的论据 \ class,\ struct,\ union或\ include命令不是输入文件
如何解决此警告?
答案 0 :(得分:5)
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标记。请改用\<
和\>
。