Template¶
Breathe has support for class and function templates. They are output as follows. For a class with a single template parameter:
.. doxygenclass:: templateclass
:project: template_class
:members:
It renders as:
-
template<typename
T
>
classtemplateclass
¶ a class with a template parameter
- Template Parameters
T
: this is the template parameter
With multiple template parameters it renders as:
-
template<typename
T
, typenameU
, intN
>
classanothertemplateclass
¶ a class with three template parameters
- Template Parameters
T
: this is the first template parameterU
: this is the second template parameterN
: this is the third template parameter, it is a non-type parameter
A function with single template parameter renders as:
-
template<typename
T
>
Tfunction1
(T arg1)¶ a function with one template arguments
- Return
return value of type T
- Template Parameters
T
: this is the template parameter
- Parameters
arg1
: argument of type T
With multiple template parameters it renders as:
-
template<typename
T
, typenameU
, intN
>
Tfunction2
(T arg1, U arg2)¶ a function with three template arguments
- Return
return value of type T
- Template Parameters
T
: this is the first template parameterU
: this is the second template parameterN
: this is the third template parameter, it is a non-type parameter
- Parameters
arg1
: first argument of type Targ2
: second argument of type U