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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
Lists
======
Breathe has support for lists in the doxygen documentation. They are output as
follows.
.. cpp:namespace:: @ex_lists_plus
For unordered lists with list items prefixed with **+**:
.. code-block:: rst
.. doxygenclass:: SimpleList_1
:project: lists
It renders as:
----
.. doxygenclass:: SimpleList_1
:project: lists
----
.. cpp:namespace:: @ex_lists_dash
Unordered lists with list items prefixed with **-** render as:
----
.. doxygenclass:: SimpleList_2
:project: lists
----
.. cpp:namespace:: @ex_lists_star
Unordered lists with list items prefixed with **\*** render as:
----
.. doxygenclass:: SimpleList_3
:project: lists
----
.. cpp:namespace:: @ex_lists_html
Unordered lists defined using HTML tags **<ul><li>** render as:
----
.. doxygenclass:: SimpleList_6
:project: lists
----
.. cpp:namespace:: @ex_lists_auto
Auto-numbered lists with list items prefixed with **-#** render as:
----
.. doxygenclass:: SimpleList_4
:project: lists
----
.. cpp:namespace:: @ex_lists_arabic
Numbered lists with list items prefixed with Arabic numerals **1. 2. ...** render as:
----
.. doxygenclass:: SimpleList_5
:project: lists
----
.. note::
Numbered lists support for the moment only Arabic numerals.
Nested lists are supported in all combinations, as long as they are valid doxygen markup.
Below are a couple of examples of different nested lists documentation and their corresponding
breathe output.
.. cpp:namespace:: @ex_lists_nested_1
Documentation looking like this:
.. literalinclude:: code/nested_list_1.h
:language: cpp
renders as:
----
.. doxygenclass:: NestedLists_1
:project: lists
----
.. cpp:namespace:: @ex_lists_nested_2
Documentation looking like this:
.. literalinclude:: code/nested_list_2.h
:language: cpp
renders as:
----
.. doxygenclass:: NestedLists_2
:project: lists
----
.. cpp:namespace:: @ex_lists_nested_3
Documentation looking like this:
.. literalinclude:: code/nested_list_3.h
:language: cpp
renders as:
----
.. doxygenclass:: NestedLists_3
:project: lists
----
.. cpp:namespace:: @ex_lists_nested_4
Documentation looking like this:
.. literalinclude:: code/nested_list_4.h
:language: cpp
renders as:
----
.. doxygenclass:: NestedLists_4
:project: lists
----
.. cpp:namespace:: @ex_lists_nested_5
Documentation looking like this:
.. literalinclude:: code/nested_list_5.h
:language: cpp
renders as:
----
.. doxygenclass:: NestedLists_5
:project: lists
|
