使用Doxygen(C++)的模板类中的typedef
使用Doxygen（C++）的模板类中的typedef，可以通过以下步骤完成：
- 在模板类定义之前，使用typedef关键字定义一个别名，该别名将作为模板类的简称。例如，如果您有一个名为“MyTemplate”的模板类，可以使用以下代码定义一个别名：
template<typename T>
class MyTemplate;
template<typename T>
using MyTemplateAlias = MyTemplate<T>;- 在Doxygen注释中，使用\@typedef命令来描述typedef。例如：
/**
* @brief 这是一个模板类的typedef示例。
*
* 这里是详细的描述。
*
* @tparam T 模板参数的类型
*/
template<typename T>
using MyTemplateAlias = MyTemplate<T>;- 在模板类定义中，使用\@brief、\@param、\@return等命令来描述模板类的功能。例如：
/**
* @brief 这是一个模板类的示例。
*
* 这里是详细的描述。
*
* @tparam T 模板参数的类型
*/
template<typename T>
class MyTemplate
{
public:
/**
* @brief 这是一个模板类的构造函数。
*
* @param value 构造函数的参数
*/
MyTemplate(T value);
/**
* @brief 这是一个模板类的成员函数。
*
* @return 返回一个T类型的值
*/
T getValue() const;
private:
T m_value; ///< 存储一个T类型的值
};- 在使用模板类的地方，使用typedef的别名来创建对象。例如：
MyTemplateAlias<int> myObject(42);
int value = myObject.getValue();通过以上步骤，您可以在Doxygen中使用typedef来定义模板类的别名，并且为模板类和其成员函数添加注释。
相关·内容
我有一些带有模板的C++源代码，可能是这样的- doxygen运行时没有错误，但输出中没有添加任何文档，这是怎么回事？
///
/// A class
///
class A
{
///
/// A typedef
///
typedef B<C<D>> SomeTypedefOfTemplates;
};
浏览 0提问于2008-10-16得票数 2
回答已采纳
您好，我有一个问题，用Doxygen记录C++类静态模板函数：
Clazz.h：
#ifndef CLAZZ_H
#define CLAZZ_H
/*! \file clazz.h
* \brief Clazz declaration
* \author Me and myself
* \sa Clazz
*/
/*! \class Clazz
* \brief About class
*/
class Clazz
{
public:
/*! \fn TYPE func(TYPE value)
* \brief About static func
浏览 7提问于2014-02-21得票数 4
2回答
大数库的泛型包装器类
、、、
我目前的实现定义了一个模板抽象基类，我在其中实现了所有必需的运算符(只是为了获得一些语法上的甜头)，并定义了所需的纯虚函数。
对于每个库，我都有一个这样的派生类：class BigNumberGmp : public BigNumberBase<BigNumberGmp>。我知道这有点破坏了OOP，但C++协方差功能限制太多，它不允许我从方法返回BigNumberBase对象，只能返回引用，这是非常不可取的……
问题是，我希望使用我的自定义包装器的代码能够与任何这样的包装器一起工作: BigNumberGmp、BigNumberOpenSsl等。为了实现这一点，我定义了BigNum
浏览 1提问于2012-04-29得票数 0
回答已采纳
1回答
我有一个结构类似于：
/**
* Typical dOxygen brief about the typedef. Longer description follows.
*/
typedef struct _SOME_STRUCT_TAG {
int var1; /**< Something useful. */
int var2; /**< something equally useful. */
} SOME_STRUCT_T, *LPSOME_STRUCT_T /**< A post doc the pointer here. Longer desc
浏览 4提问于2014-06-24得票数 0
回答已采纳
6回答
我一直在搜索一些描述如何使用doxygen生成简单类图的材料，但找不到。有人能帮上忙吗？
我需要从一组C++文件创建如下所示的图。
如果有更好的工具可以更容易地实现这一点，请让我知道。
浏览 31提问于2011-01-21得票数 105
回答已采纳
4回答
我有一个从C++移植到Java的应用程序。有一段C++代码，我觉得很奇怪。
typedef std::string ArgName;
typedef std::map< ArgName, AnyData > ArgumentMap;
class Arguments : public ArgumentMap
{
public:
// Very important note: When read finds a numeric/set argument,
// it sets anyData.kind to Int. But STILL, it fills a
浏览 4提问于2014-03-17得票数 1
回答已采纳
1回答
我正在编写一个库，它广泛地使用了元编程，并且有一些特性类，例如
/// Doxygen comments...
template<class T>
struct unit_traits<T, typename void_t<
typename T::base_unit_type,
typename T::conversion_ratio,
typename T::pi_exponent_ratio,
typename T::translation_ratio>::type>
{
typedef typename T::
浏览 1提问于2016-02-10得票数 1
回答已采纳
以下C++代码：
template<typename State>
class Node
{
public:
typedef typename State::Move Move;
...
}
说：
缺少类型说明符- int假设。注意: C++不支持默认-int。
我搜索了错误消息，每个人都建议将typename关键字添加到typedef行中，在我的例子中，这已经存在了。我还能做什么？
浏览 1提问于2016-10-08得票数 0
回答已采纳
2回答
我是C++世界的新手，我不明白在使用这种结构时发生了什么：
template <typename T>
class NameClass{
.........
};
typedef NameClass<CryptoPP::AES> CryptAES;
//!Typedef for the AES Encryption\Decryption
typedef NameClass<CryptoPP::Blowfish> CryptBlowFish;
//!Typedef for BlowFish Encryption\Decryption
有什么解释吗？
浏览 2提问于2014-09-10得票数 2
回答已采纳
2回答
请考虑以下C++声明宏：
#define DECLARE_OBJECT_HANDLE(x) \
typedef struct x##HandleTag *x##Handle; \
typedef struct x##Handle *P##x##Handle
我想用一些doxygen注释来标记我的第二个指针声明。理想情况下，我希望第二个句柄引用第一个句柄，只提供简短的描述，说明它是指向这种类型的指针。
我改变了我的宏：
#define DECLARE_OBJECT_HANDLE(x) \
typedef struct x##HandleTag *x##Handle; \
/**
* \brief
浏览 1提问于2016-12-19得票数 2
回答已采纳
Resharper C++ 2017可以为函数、类和其他一切生成doxygen标头。
但是，它使用\前缀编写命令，并且为了与我的项目的其他模块保持一致，我需要使用@前缀。
我假设这是可能的，因为命令名为Document (使用'doc‘活动模板)。
如何在resharper中更改doxygen格式样式？
浏览 5提问于2017-06-23得票数 2
回答已采纳
我使用doxygen来记录C++库。
假设我有几个类A、B、C等，它们共享一组公共的方法(A::m1(), B::m1(), ...等)。这些方法在每个类中做同样的事情。
我想要这些通用方法的单一实现。
另一种选择是，类(A、B、C等)继承具有公共方法的公共类。但是，根据我的度量，这种方法在与多继承相结合时意味着性能上的轻微牺牲。事实上，我的一些类继承了其他类，所以多继承是肯定的。
因此，为了“分解”常用的方法，我在一个大宏中编写了它们。类似于：
define COMMON_METHODS() \
void m1() { ..- } \
void m2() { ... \
然后，在每堂课中，
浏览 0提问于2015-05-12得票数 1
回答已采纳
我使用doxygen 1.7.1为一些C++ 11代码生成文档，它似乎忽略了我的模板别名。
为了清楚起见，下面是一个模板别名的示例：
template<class T>
using ResultOf = std::result_of<T>::type;
它也无法获得更多使用更干净的新using语法编写的传统typedefs：
using PredicateOne = std::function<bool(string)>; // Doxygen doesn't catch this
typedef std::function<bool(str
浏览 0提问于2012-09-21得票数 4
回答已采纳
下面的代码给出了预期的编译器错误()：
1 template<bool> struct Range;
2
3 template<int value, typename = Range<true> > struct Unique;
4 template<int value> struct Unique<value, Range<(value > 1)> > { typedef char type[1]; };
5 template<int value> struct Unique<
浏览 1提问于2012-03-06得票数 6
回答已采纳
我的问题是关于如何用Doxygen在模板类中注释typedef。我将举一个例子来说明我的问题：
namespace fundamental
{
/**
* Basic function
*/
template <typename T>
class Base
{
public:
T x; ///< x coordinate
T y; ///< y coordinate
};
typedef Base<float> Coordinate; ///< Poi
浏览 4提问于2012-08-07得票数 9
回答已采纳
8回答
我在玩弄模板。我并不是要重新发明std::vector，我只是想要掌握C++中的模板。
我可以做以下事情吗？
template <typename T>
typedef struct{
size_t x;
T *ary;
}array;
我正在尝试做的是一个基本的模板化版本：
typedef struct{
size_t x;
int *ary;
}iArray;
如果我使用类而不是struct，它看起来是可以工作的，那么使用typedef struct是不可能的吗？
浏览 2提问于2010-03-15得票数 75
回答已采纳
6回答
条件变量声明
、、
我来自Python，在c++中管理类型时遇到了一些问题。在Python中，我可以这样做：
if condition_is_true:
x=A()
else:
x=B()
在程序的其余部分中，我可以使用x，而不用关心x的类型，因为我使用的方法和成员变量具有相同的名称和参数(不一定A和B具有相同的基类)。现在，在我的C++代码中，类型A对应于
typedef map<long, C1> TP1;
和B到：
typedef map<long, C2> TP2;
其中：
typedef struct C1
{
char* code;
char*
浏览 2提问于2011-07-26得票数 5
我正在尝试为我的Python项目生成Doxygen文档。Doxygen似乎没有提供包括关联在内的项目的整体类图。它只显示单个文件的继承。有没有办法在doxygen中生成一个整体的类图？ 非常感谢!
浏览 53提问于2021-08-30得票数 0
回答已采纳
2回答
我有一个头文件，其中包含：
class ClassName {
...
////////////////////////////////////////////////////////////////////////////////////////////////////
/// \fn boost::function<int(void *, char *)> ClassName::getFnPtr();
///
/// \brief ...
///
/// \author ...
/// \date ...
///
/// \return A boost function ob
浏览 0提问于2012-06-02得票数 2
回答已采纳
1回答
DO2不一致地扩展C宏
、、、
上下文
在用C编写的项目中，我使用doxygen作为文档。在这个项目中，有很多重复的代码。由于我仅限于使用纯C(不允许使用C++ )，所以我使用宏来减少源文件中的重复。在宏生成的代码中，我希望包括函数和类型声明(它们遵循一种模式，实际的宏相当容易编写)。我非常希望这些生成的函数和类型出现在doxygen文档中，因为它们对于库API至关重要。然而，我正在努力使doxygen正确地扩展宏。
问题
氧气并不总是膨胀宏。例如，在同一代码行中，第一次扩展相同的类似于函数的宏，而不是第二次。
我认为解释这个问题的最好方法是显示一个MRE (您可以从下载)。
示例源文件
考虑以下文件singlefile.h
浏览 4提问于2021-07-02得票数 8
回答已采纳
我正在使用Eclipse CDT编写C++代码。在StackOverflow上阅读了几篇关于是否将doxygen文档放在头文件或实现文件中的讨论后，似乎大多数开发人员倾向于将doxygen注释放在头文件中(当然，这并不是一个共识)。但是，如果我将doxygen注释放在头文件中，当我将鼠标指针悬停在已注释的方法/成员的实例上时，就不能让Eclipse显示这些注释。有没有一种方法可以让Eclipse使用我在Eclipse悬停提示中头文件中的Doxygen文档？
我已经在Preferences > C/C++ > Editor中将"Documentation tool comme
浏览 6提问于2011-06-23得票数 28
最近我注意到，C++ std::less是一个类，尽管它只是简单地比较了两个objects.Here的值，这是一个示例代码：
template <class T> struct less {
bool operator() (const T& x, const T& y) const {return x<y;}
typedef T first_argument_type;
typedef T second_argument_type;
typedef bool result_type;
};
那么，定义类而不是函数有什么好处呢？我也想知道为什么
浏览 5提问于2021-12-01得票数 4
回答已采纳
1回答
如何使预处理宏贪婪？
、、、、
我们有以下预处理宏。它用于帮助DO2文档，因为DO2在C++和一些模板类型方面有问题：
#if defined(DOXYGEN_PROCESSING)
# define DOCUMENTED_TYPEDEF(x, y) class y : public x {};
#else
# define DOCUMENTED_TYPEDEF(x, y) typedef x y;
#endif
当X是一个非模板或者只有一个模板参数时，它会很好地工作。但是，如果X是一个具有多个参数的模板：
DOCUMENTED_TYPEDEF(Foo<R,S>,Bar);
然后，它会导致编译错误，因为字符串被拆
浏览 3提问于2016-04-08得票数 4
回答已采纳
我有以下类型的定义：
typedef void( __cdecl *tCallback )( const char* Message );
我如何使用Doxygen正确地记录这一点？
我想有记录的tCallback和预期的参数记录。
一个简单的例子：
/// \typedef test
typedef test bool
在doxygen中生成正确的输出
//typedef tCallback
typedef void( __cdecl *tCallback )( const char* Message );
产生：
C:/test.cpp:2: warning: Found ';&#
浏览 1提问于2011-01-29得票数 8
回答已采纳
2回答
我有一个用C++编写的项目，在该项目中，我还使用swig生成一些C#包装器。C++代码使用Doxygen注释来注释类和函数。能让Swig接受这些doxygen注释并为C#包装类和函数生成doxygen注释吗？
浏览 9提问于2016-06-13得票数 6
1回答
template<class T> struct A {
typedef int Int;
A::Int b; // Line 1 (fails)
Int c; // Line 2 (compiles)
};
int main(){
A<int> x;
x.c = 13;
}
错误
error: ISO C++ forbids declaration of ‘Int’ with no type
error: extra qualification ‘A<T>::’ on member ‘Int’
error: e
浏览 1提问于2011-05-21得票数 4
回答已采纳
3回答
我想要从Doxygen的文档中排除一个类。通常，这些类位于名称相同的文件中，但在许多情况下，它们会包含在其他类定义中。这主要是针对以"_“或"Private”开头的类。
我如何告诉Doxygen排除一个C++类？
提前谢谢。
浏览 0提问于2009-10-25得票数 12
1回答
我是新来C++的，所以请容忍我。我正在尝试理解STL iterator_traits。在“C++标准库”一书中，结构iterator_traits的定义如下：
template <class T>
struct iterator_traits {
typedef typename T::value_type value_type;
typedef typename T::difference_type difference_type;
typedef typename T::iterator_category iterator_category;
typedef t
浏览 3提问于2011-07-19得票数 30
回答已采纳
4回答
使用c++语言:我创建了一个泛型结构，我想给它一个别名，但失败了！代码如下：
template<class T>
struct noeud {
T val;
struct noeud *next;
};
typedef struct noeud * Noeud;
下面是错误：
'struct noeud‘所需的模板参数在';’标记生成之前的声明中类型无效:2个错误，0个警告
浏览 1提问于2014-02-03得票数 0
4回答
继承而不是类型定义
、、、
C++无法将typedef或typedef作为模板化类来创建模板。我知道如果我继承并使我的类成为一个模板，它将会工作。
示例：
// Illegal
template <class T>
typedef MyVectorType vector<T>;
//Valid, but advantageous?
template <class T>
class MyVectorType : public vector<T> { };
这样做是有利的，这样我就可以“伪造”一个类型定义，还是有更好的方法来做到这一点？
浏览 0提问于2009-01-14得票数 11
回答已采纳
1回答
使用我的自定义迭代器和STL算法
、、、、
我正在尝试创建我自己的迭代器，我已经让它像预期的那样使用std::generate算法。但是，当我尝试std：：std::max_element时，会发现一些隐秘的错误。
下面是我的迭代器的接口：
template <typename GridT,
typename GridPtr,
typename GridRef,
template <typename> class ShapeT>
class GridIterator
{
public:
typedef GridIterator<GridT,
浏览 2提问于2014-12-06得票数 4
回答已采纳
在我的C++库中，在许多模块中，我都像这样使用typedef：
class ClassName {
//...
}
typedef ClassName AlternateClassName;
我这样做只是为了让我自己和潜在的其他人允许我的班级被他们的官方名称以外的名字所称呼--只不过是同义词而已。这是typedef的好用法吗？
浏览 5提问于2019-10-22得票数 0
回答已采纳
2回答
到模板类型
、、
下面这是怎么回事？
typedef boost::shared_ptr SharedPtr;
GCC犯了以下错误：
ISO C++禁止无类型的“shared_ptr”声明
浏览 3提问于2011-04-06得票数 4
回答已采纳
1回答
我需要一些方法来实现“反向模板别名”。因此，我将使用一个模板typedef来选择要在编译时使用的正确类。我想做以下几件事：
typedef ClassA Temp<int>;
typedef ClassB Temp<char>;
ClassA和ClassB不是模板类，但我希望通过使用模板来选择正确的类。因此，如果需要Temp< int >，它实际上将使用ClassA。在C++中，这样的事情有可能实现吗？我尝试了以下方法，但不起作用。
template<>
typedef ClassA Temp<int>;
template<&
浏览 0提问于2011-08-26得票数 2
回答已采纳
3回答
我正在查看我的项目中的以下代码，我似乎无法弄清楚数据是如何存储在下面的the中的。我是C++的新手，所以对typedef和模板的理解有限。我对这样的场景进行了很好的描述，但没有取得什么结果。
我的想法是，由squareTemplate生成的任意类型的参数都有三个值:面积、高度和宽度。但我不知道<bool, bool>和<std::vector<std ::pair<double, double>>,std::vector<std::pair<int, int>>>是做什么的？所有3种类型都包含区域、高度和宽度变量吗？请解释
浏览 0提问于2018-03-07得票数 2
回答已采纳
2回答
我有一个模板化的结构，然后我将其专门化如下：
template <class T>
struct FunctionSignature;
template <class Return, class Arg0>
struct FunctionSignature<Return (Arg0)>
{
typedef Return(*type)(Arg0);
};
所以我实例化如下：
FunctionSignature<int (const std::string& str)>::type f = &onefunction;
函数f
浏览 2提问于2018-01-05得票数 1
回答已采纳
我正在使用带有CDT的eclipse Juno。我已经在cpp文件中编写了一个函数，我想为该函数添加注释。CDT是否支持通过“输入/**然后按enter”自动生成注释？在我的例子中，自动生成的注释仅如下所示。
/**
*
*/
正如所解释的那样，我甚至配置使用Doxygen support.Go to C/C++ ->编辑器->文档工具注释: Doxygen。
我仍然得到如上所述的评论。如何将eclipse配置为添加我自己风格的注释？
我甚至在代码模板中更改了注释。转到C/C++ ->代码样式->代码模板->注释。我更改了类型、字段和方法。对我来说还是没有什
浏览 1提问于2012-07-21得票数 14
4回答
我们都有记录代码的好习惯，对吧？
现在，代码文档本身就有一个语法.它几乎就像一种编程语言。问题如下：
有多少文档语法规范？
有标准的文档语法吗？
谁来定义这个标准？是否有正式的委员会或机构(就像定义C++标准的委员会一样)？
还是"doxygen“已经成为事实上的标准？
很难不听说过多塞根的事。在我参与的每一个开源软件项目中都提到了这一点。然而，看看官方的doxygen网站，还不清楚doxygen定义了任何类型的规范！当我读到“它可以帮助我的方式”时，我的印象是doxygen仅仅是一个提取代码文档并以漂亮的HTML页面显示它的软件。查看doxygen首页，我甚至
浏览 3提问于2010-08-27得票数 26
回答已采纳
2回答
我真的不认为用于记录C代码的Doxygen主题对于记录函数和过程是很好的(尽管如果使用C++，它对于记录OOP是很棒的)。所以我想问的是，是否可以将输出更改为类似于或
浏览 1提问于2012-03-09得票数 11
我正在用LaTeX编写一些软件的手册。我不得不使用文章类。我必须在手册中包括各个c++类的文档。我正在寻找doxygen，但我从未使用过doxygen (如果有更好的方法，请告诉我)。
我可以让doxygen为我的整个项目生成一个很好的LaTeX (-> pdf)文件。但是，我想要做的是以某种方式提取每个类的LaTeX源代码，并将它放到我的LaTeX手动源代码中的适当位置。
我已经尝试将来自refman.tex (由doxygen生成)的所有序言内容放在我的序言中，然后在后面的文档中使用\input来包含单个类的tex文件。在清理了一些冲突之后，我找到了一个我不知道该如何克服的冲突。do
浏览 0提问于2012-08-31得票数 3
2回答
再来几次酒后警告
、、
我正在尝试在c++库中创建一些红宝石包装器。我的大部分工作，但我有一些警告，我想修复。
问题在于两个头文件，下面是代码片段
typedef std::set<WParm,std::less<WParm> > WParmlistType;
typedef WParmlistType::iterator WParmlistIter;
class WParmlist : public WParmlistType {
我得到的警告..。警告401:不知道基类“WParmlistType”。已忽略。
第二个标题类似：
typedef std::vector<WStrin
浏览 4提问于2013-12-16得票数 0
回答已采纳
我在一个C项目中使用doxygen有以下问题。我有很多内部结构还没有记录下来。因此，它在我的文档中设置了EXTRACT_ALL=NO。不幸的是，doxygen仍然提取其中的一些。下面是一个最小的工作示例。假设以下头文件：
#ifndef HASHTABLE_H
# define HASHTABLE_H
#ifdef __cplusplus
extern "C" {
#endif
typedef void* object;
typedef char *(*object_getname)( object obj);
typedef void (*object_free)( obje
浏览 1提问于2014-04-16得票数 1
回答已采纳
2回答
下面的代码
#include <stdio.h>
template <typename T, T v> class Tem
{
T t;
Tem()
{
t = v;
}
};
typedef Tem<FILE*,NULL> TemFile;
在MacOS X上使用Xcode在.mm文件(Objective C++)中编译时，会引发以下错误：
错误:无法将模板参数'0‘转换为'FILE*’。
这是怎么回事？有问题的代码在MSVC下编译得很好。从什么时候开始0常量不是指向任何东西的有效指针？这是
浏览 0提问于2010-03-31得票数 2
回答已采纳
我想知道在用doxygen记录C++函数时是否可以使用当前日期。例如
/**
* This function is really boring. Documentation generated on __DATE__
*/
void f()
{}
有这样的命令吗？__ DATE __ C++宏不工作，因为它位于注释中，因此预处理器不会展开它。我可以使用LaTeX宏，如\f$\mathrm{\today}\f$，但它看起来很难看。
浏览 2提问于2014-10-25得票数 0
回答已采纳
4回答
是否可以使用相同的名称定义两个不同的模板(通过模板参数的数量)？
这是我想要做的：
namespace MyNamespace
{
template<class TRet>
class FunctionObject
{
typedef typename TRet ReturnType;
virtual ReturnType const operator()() const = 0;
};
template<class TRet, class TArg0>
class FunctionObject
{
typedef typename TRe
浏览 0提问于2012-02-28得票数 10
考虑以下doxygen别名：
ALIASES += "sbl_add_package_main_class{4}=\addtogroup \1-ref-manual ^^ @{ ^^ \class \2 ^^ \brief \3 ^^ \4 ^^ @}"
或等量
ALIASES += sbl_add_package_main_class{4}="\addtogroup \1-ref-manual ^^ @{ ^^ \class \2 ^^ \brief \3 ^^ \4 ^^ @}"
运行doxygen (1.8.18)到以下C++代码
/**
浏览 4提问于2020-09-02得票数 0
我正在使用doxygen (版本1.8.13)记录一些C++代码。当我记录函数的参数/模板参数时，我得到的结果如下： /*!
* ...
* @tparam Field The field to be decoded.
* @tparam Container The container representing the binary string.\n
* A valid container type must meet the following requirements:
* - define the member alias \c value_type, which mus
浏览 22提问于2020-01-27得票数 1
回答已采纳
在CUDA头文件/usr/local/cuda/targets/x86_64/linux/include/texture_fetch_function.h中，有以下语句：
template<typename T> struct __nv_tex_rmnf_ret{};
template<> struct __nv_tex_rmnf_ret<char> {typedef float type;};
我理解第一个语句是struct模板的定义。但后者意味着什么呢？我以前从未见过这样的C++语法。有谁能解释一下吗？提前谢谢。
浏览 14提问于2022-08-28得票数 1
回答已采纳
2回答
我们是否有任何代码文档语法和工具支持从Dart应用程序代码中生成代码文档，类似于Doxygen /C++。我更喜欢使用Markdown样式的语法，而不是doxygen-语法。
浏览 1提问于2012-10-01得票数 0
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
即时通信 IM
对象存储活动推荐
腾讯云开发者
