doxygen 文档 C++ 类模板

doxygen document c++ class templates

本文关键字：C++ 文档 doxygen      更新时间：2023-10-16

我试图记录以下内容：

template <class T, int NDim>
class myClass {
public:
.
.

这是氧气

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

发电量：

我的类类参考

为内容定义一个类。

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

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

如何解决此警告？

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

相关文章：