File: template.rst

package info (click to toggle)
breathe 4.36.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,224 kB
  • sloc: python: 12,703; cpp: 1,737; makefile: 523; xml: 168; sh: 54; ansic: 52
file content (66 lines) | stat: -rw-r--r-- 1,137 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
Template
========

.. cpp:namespace:: @ex_template_first

Breathe has support for class and function templates. They are output as
follows. For a class with a single template parameter:

.. code-block:: rst

   .. doxygenclass:: templateclass
      :project: template_class
      :members:

It renders as:

----

.. doxygenclass:: templateclass
   :project: template_class
   :members:

----

.. cpp:namespace:: @ex_template_multiple

With multiple template parameters it renders as:

----

.. doxygenclass:: anothertemplateclass
   :project: template_class_non_type
   :members:

----

.. cpp:namespace:: @ex_template_function_single

A function with single template parameter renders as:

----

.. doxygenfunction:: function1
   :project: template_function

----

.. cpp:namespace:: @ex_template_function_single_specialization

If specialized for a given type it renders as:

----

.. doxygenfunction:: function1< std::string >
   :project: template_function

----

.. cpp:namespace:: @ex_template_function_multiple

With multiple template parameters it renders as:

----

.. doxygenfunction:: function2
   :project: template_function