Skip to content

Commit a2bf2e6

Browse files
committed
Docs: Restore Doxygen macro descriptions
1 parent cbe7eb9 commit a2bf2e6

File tree

3 files changed

+250
-188
lines changed

3 files changed

+250
-188
lines changed

docs/doxygen/Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -819,7 +819,7 @@ SHOW_USED_FILES = NO
819819
# (if specified).
820820
# The default value is: YES.
821821

822-
SHOW_FILES = NO
822+
SHOW_FILES = YES
823823

824824
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
825825
# page. This will remove the Namespaces entry from the Quick Index and from the

docs/doxygen/DoxygenLayout.xml

Lines changed: 126 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<doxygenlayout version="1.0">
3-
<!-- Generated by doxygen 1.9.8 -->
2+
<doxygenlayout version="2.0">
3+
<!-- Generated by doxygen 1.14.0 -->
44
<!-- Navigation index tabs for HTML output -->
55
<navindex>
66
<tab type="mainpage" visible="yes" title="Modules"/>
7+
<tab type="pages" visible="no" title="" intro=""/>
78
<tab type="topics" visible="no" title="" intro=""/>
89
<tab type="modules" visible="no" title="" intro="">
9-
<tab type="modulelist" visible="no" title="" intro=""/>
10-
<tab type="modulemembers" visible="no" title="" intro=""/>
10+
<tab type="modulelist" visible="yes" title="" intro=""/>
11+
<tab type="modulemembers" visible="yes" title="" intro=""/>
1112
</tab>
12-
<tab type="namespaces" visible="no" title="Namespaces">
13+
<tab type="namespaces" visible="no" title="">
1314
<tab type="namespacelist" visible="yes" title="" intro=""/>
1415
<tab type="namespacemembers" visible="yes" title="" intro=""/>
1516
</tab>
16-
<tab type="concepts" visible="yes" title="Concepts">
17+
<tab type="concepts" visible="no" title="">
1718
</tab>
1819
<tab type="interfaces" visible="no" title="">
1920
<tab type="interfacelist" visible="yes" title="" intro=""/>
@@ -26,7 +27,7 @@
2627
<tab type="hierarchy" visible="yes" title="" intro=""/>
2728
<tab type="classmembers" visible="yes" title="" intro=""/>
2829
</tab>
29-
<tab type="classindex" visible="yes" title="Alphabetical"/>
30+
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title="All Classes"/>
3031
<tab type="structs" visible="no" title="">
3132
<tab type="structlist" visible="yes" title="" intro=""/>
3233
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
@@ -46,56 +47,57 @@
4647

4748
<!-- Layout definition for a class page -->
4849
<class>
49-
<detaileddescription title=""/>
50+
<briefdescription visible="no"/>
51+
<detaileddescription visible="yes" title=""/>
5052
<includes visible="$SHOW_HEADERFILE"/>
51-
<inheritancegraph visible="$CLASS_GRAPH"/>
53+
<inheritancegraph visible="yes"/>
5254
<collaborationgraph visible="yes"/>
5355
<memberdecl>
5456
<nestedclasses visible="yes" title=""/>
55-
<publictypes title=""/>
56-
<services title=""/>
57-
<interfaces title=""/>
58-
<publicslots title=""/>
59-
<signals title=""/>
60-
<publicmethods title=""/>
61-
<publicstaticmethods title=""/>
62-
<publicattributes title=""/>
63-
<publicstaticattributes title=""/>
64-
<protectedtypes title=""/>
65-
<protectedslots title=""/>
66-
<protectedmethods title=""/>
67-
<protectedstaticmethods title=""/>
68-
<protectedattributes title=""/>
69-
<protectedstaticattributes title=""/>
70-
<packagetypes title=""/>
71-
<packagemethods title=""/>
72-
<packagestaticmethods title=""/>
73-
<packageattributes title=""/>
74-
<packagestaticattributes title=""/>
75-
<properties title=""/>
76-
<events title=""/>
77-
<privatetypes title=""/>
78-
<privateslots title=""/>
79-
<privatemethods title=""/>
80-
<privatestaticmethods title=""/>
81-
<privateattributes title=""/>
82-
<privatestaticattributes title=""/>
83-
<friends title=""/>
84-
<related title="" subtitle=""/>
57+
<publictypes visible="yes" title=""/>
58+
<services visible="yes" title=""/>
59+
<interfaces visible="yes" title=""/>
60+
<publicslots visible="yes" title=""/>
61+
<signals visible="yes" title=""/>
62+
<publicmethods visible="yes" title=""/>
63+
<publicstaticmethods visible="yes" title=""/>
64+
<publicattributes visible="yes" title=""/>
65+
<publicstaticattributes visible="yes" title=""/>
66+
<protectedtypes visible="yes" title=""/>
67+
<protectedslots visible="yes" title=""/>
68+
<protectedmethods visible="yes" title=""/>
69+
<protectedstaticmethods visible="yes" title=""/>
70+
<protectedattributes visible="yes" title=""/>
71+
<protectedstaticattributes visible="yes" title=""/>
72+
<packagetypes visible="yes" title=""/>
73+
<packagemethods visible="yes" title=""/>
74+
<packagestaticmethods visible="yes" title=""/>
75+
<packageattributes visible="yes" title=""/>
76+
<packagestaticattributes visible="yes" title=""/>
77+
<properties visible="yes" title=""/>
78+
<events visible="yes" title=""/>
79+
<privatetypes visible="yes" title=""/>
80+
<privateslots visible="yes" title=""/>
81+
<privatemethods visible="yes" title=""/>
82+
<privatestaticmethods visible="yes" title=""/>
83+
<privateattributes visible="yes" title=""/>
84+
<privatestaticattributes visible="yes" title=""/>
85+
<friends visible="yes" title=""/>
86+
<related visible="yes" title="" subtitle=""/>
8587
<membergroups visible="yes"/>
8688
</memberdecl>
8789
<memberdef>
88-
<inlineclasses title=""/>
89-
<typedefs title=""/>
90-
<enums title="Member Enums"/>
91-
<services title=""/>
92-
<interfaces title=""/>
93-
<constructors title="Constructors and Destructors"/>
94-
<functions title="Member Functions"/>
95-
<related title=""/>
96-
<variables title=""/>
97-
<properties title=""/>
98-
<events title=""/>
90+
<inlineclasses visible="yes" title=""/>
91+
<typedefs visible="yes" title=""/>
92+
<enums visible="yes" title="Member Enums"/>
93+
<services visible="yes" title=""/>
94+
<interfaces visible="yes" title=""/>
95+
<constructors visible="yes" title="Constructors and Destructors"/>
96+
<functions visible="yes" title="Member Functions"/>
97+
<related visible="yes" title=""/>
98+
<variables visible="yes" title=""/>
99+
<properties visible="yes" title=""/>
100+
<events visible="yes" title=""/>
99101
</memberdef>
100102
<allmemberslink visible="yes"/>
101103
<usedfiles visible="$SHOW_USED_FILES"/>
@@ -113,23 +115,25 @@
113115
<concepts visible="yes" title=""/>
114116
<structs visible="yes" title=""/>
115117
<exceptions visible="yes" title=""/>
116-
<typedefs title=""/>
117-
<sequences title=""/>
118-
<dictionaries title=""/>
119-
<enums title=""/>
120-
<functions title=""/>
121-
<variables title=""/>
118+
<typedefs visible="yes" title=""/>
119+
<sequences visible="yes" title=""/>
120+
<dictionaries visible="yes" title=""/>
121+
<enums visible="yes" title=""/>
122+
<functions visible="yes" title=""/>
123+
<variables visible="yes" title=""/>
124+
<properties visible="yes" title=""/>
122125
<membergroups visible="yes"/>
123126
</memberdecl>
124-
<detaileddescription title=""/>
127+
<detaileddescription visible="yes" title=""/>
125128
<memberdef>
126-
<inlineclasses title=""/>
127-
<typedefs title=""/>
128-
<sequences title=""/>
129-
<dictionaries title=""/>
130-
<enums title=""/>
131-
<functions title=""/>
132-
<variables title=""/>
129+
<inlineclasses visible="yes" title=""/>
130+
<typedefs visible="yes" title=""/>
131+
<sequences visible="yes" title=""/>
132+
<dictionaries visible="yes" title=""/>
133+
<enums visible="yes" title=""/>
134+
<functions visible="yes" title=""/>
135+
<variables visible="yes" title=""/>
136+
<properties visible="yes" title=""/>
133137
</memberdef>
134138
<authorsection visible="yes"/>
135139
</namespace>
@@ -139,7 +143,7 @@
139143
<briefdescription visible="yes"/>
140144
<includes visible="$SHOW_HEADERFILE"/>
141145
<definition visible="yes" title=""/>
142-
<detaileddescription title=""/>
146+
<detaileddescription visible="yes" title=""/>
143147
<authorsection visible="yes"/>
144148
</concept>
145149

@@ -158,25 +162,27 @@
158162
<namespaces visible="yes" title=""/>
159163
<concepts visible="yes" title=""/>
160164
<constantgroups visible="yes" title=""/>
161-
<defines title=""/>
162-
<typedefs title=""/>
163-
<sequences title=""/>
164-
<dictionaries title=""/>
165-
<enums title=""/>
166-
<functions title=""/>
167-
<variables title=""/>
165+
<defines visible="yes" title=""/>
166+
<typedefs visible="yes" title=""/>
167+
<sequences visible="yes" title=""/>
168+
<dictionaries visible="yes" title=""/>
169+
<enums visible="yes" title=""/>
170+
<functions visible="yes" title=""/>
171+
<variables visible="yes" title=""/>
172+
<properties visible="yes" title=""/>
168173
<membergroups visible="yes"/>
169174
</memberdecl>
170-
<detaileddescription title=""/>
175+
<detaileddescription visible="yes" title=""/>
171176
<memberdef>
172-
<inlineclasses title=""/>
173-
<defines title=""/>
174-
<typedefs title=""/>
175-
<sequences title=""/>
176-
<dictionaries title=""/>
177-
<enums title=""/>
178-
<functions title=""/>
179-
<variables title=""/>
177+
<inlineclasses visible="yes" title=""/>
178+
<defines visible="yes" title=""/>
179+
<typedefs visible="yes" title=""/>
180+
<sequences visible="yes" title=""/>
181+
<dictionaries visible="yes" title=""/>
182+
<enums visible="yes" title=""/>
183+
<functions visible="yes" title=""/>
184+
<variables visible="yes" title=""/>
185+
<properties visible="yes" title=""/>
180186
</memberdef>
181187
<authorsection/>
182188
</file>
@@ -193,42 +199,42 @@
193199
<namespaces visible="yes" title=""/>
194200
<concepts visible="yes" title=""/>
195201
<classes visible="yes" title=""/>
196-
<defines title=""/>
197-
<typedefs title=""/>
198-
<sequences title=""/>
199-
<dictionaries title=""/>
200-
<enums title=""/>
201-
<enumvalues title=""/>
202-
<functions title=""/>
203-
<variables title=""/>
204-
<signals title=""/>
205-
<publicslots title=""/>
206-
<protectedslots title=""/>
207-
<privateslots title=""/>
208-
<events title=""/>
209-
<properties title=""/>
210-
<friends title=""/>
202+
<defines visible="yes" title=""/>
203+
<typedefs visible="yes" title=""/>
204+
<sequences visible="yes" title=""/>
205+
<dictionaries visible="yes" title=""/>
206+
<enums visible="yes" title=""/>
207+
<enumvalues visible="yes" title=""/>
208+
<functions visible="yes" title=""/>
209+
<variables visible="yes" title=""/>
210+
<signals visible="yes" title=""/>
211+
<publicslots visible="yes" title=""/>
212+
<protectedslots visible="yes" title=""/>
213+
<privateslots visible="yes" title=""/>
214+
<events visible="yes" title=""/>
215+
<properties visible="yes" title=""/>
216+
<friends visible="yes" title=""/>
211217
<membergroups visible="yes"/>
212218
</memberdecl>
213-
<detaileddescription title=""/>
219+
<detaileddescription visible="yes" title=""/>
214220
<memberdef>
215221
<pagedocs/>
216-
<inlineclasses title=""/>
217-
<defines title=""/>
218-
<typedefs title=""/>
219-
<sequences title=""/>
220-
<dictionaries title=""/>
221-
<enums title=""/>
222-
<enumvalues title=""/>
223-
<functions title=""/>
224-
<variables title=""/>
225-
<signals title=""/>
226-
<publicslots title=""/>
227-
<protectedslots title=""/>
228-
<privateslots title=""/>
229-
<events title=""/>
230-
<properties title=""/>
231-
<friends title=""/>
222+
<inlineclasses visible="yes" title=""/>
223+
<defines visible="yes" title=""/>
224+
<typedefs visible="yes" title=""/>
225+
<sequences visible="yes" title=""/>
226+
<dictionaries visible="yes" title=""/>
227+
<enums visible="yes" title=""/>
228+
<enumvalues visible="yes" title=""/>
229+
<functions visible="yes" title=""/>
230+
<variables visible="yes" title=""/>
231+
<signals visible="yes" title=""/>
232+
<publicslots visible="yes" title=""/>
233+
<protectedslots visible="yes" title=""/>
234+
<privateslots visible="yes" title=""/>
235+
<events visible="yes" title=""/>
236+
<properties visible="yes" title=""/>
237+
<friends visible="yes" title=""/>
232238
</memberdef>
233239
<authorsection visible="yes"/>
234240
</group>
@@ -240,13 +246,13 @@
240246
<memberdecl>
241247
<concepts visible="yes" title=""/>
242248
<classes visible="yes" title=""/>
243-
<enums title=""/>
244-
<typedefs title=""/>
245-
<functions title=""/>
246-
<variables title=""/>
247-
<membergroups title=""/>
249+
<enums visible="yes" title=""/>
250+
<typedefs visible="yes" title=""/>
251+
<functions visible="yes" title=""/>
252+
<variables visible="yes" title=""/>
253+
<membergroups visible="yes" title=""/>
248254
</memberdecl>
249-
<detaileddescription title=""/>
255+
<detaileddescription visible="yes" title=""/>
250256
<memberdecl>
251257
<files visible="yes"/>
252258
</memberdecl>
@@ -260,6 +266,6 @@
260266
<dirs visible="yes"/>
261267
<files visible="yes"/>
262268
</memberdecl>
263-
<detaileddescription title=""/>
269+
<detaileddescription visible="yes" title=""/>
264270
</directory>
265271
</doxygenlayout>

0 commit comments

Comments
 (0)