Skip to content

Commit 4836b7e

Browse files
eramongodberamongodb
authored
CXX-3083 Reorganize layout of Doxygen API page content (#1183)
* doxygen: set GENERATE_TODOLIST = NO * doxygen: set GENERATE_TESTLIST = NO * doxygen: set GENERATE_BUGLIST = NO * doxygen: add docs/DoxygenLayout.xml * doxygen: reorder navigation index tabs * doxygen: set visible="no" for unused tabs * doxygen: set visible="no" for the Examples tab * doxygen: rename "Related Pages" -> "Topics" and "Modules" -> "Groups" * doxygen: move detailed description to top of all pages * doxygen: move usedfiles immediately after description * doxygen: set HTML_INDEX_NUM_ENTRIES = 0 (fully expand trees by default)
1 parent ed1329d commit 4836b7e

File tree

5 files changed

+232
-14
lines changed

5 files changed

+232
-14
lines changed

‎Doxyfile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -684,19 +684,19 @@ STRICT_PROTO_MATCHING = NO
684684
# list. This list is created by putting \todo commands in the documentation.
685685
# The default value is: YES.
686686

687-
GENERATE_TODOLIST = YES
687+
GENERATE_TODOLIST = NO
688688

689689
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
690690
# list. This list is created by putting \test commands in the documentation.
691691
# The default value is: YES.
692692

693-
GENERATE_TESTLIST = YES
693+
GENERATE_TESTLIST = NO
694694

695695
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
696696
# list. This list is created by putting \bug commands in the documentation.
697697
# The default value is: YES.
698698

699-
GENERATE_BUGLIST = YES
699+
GENERATE_BUGLIST = NO
700700

701701
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
702702
# the deprecated list. This list is created by putting \deprecated commands in
@@ -764,7 +764,7 @@ FILE_VERSION_FILTER =
764764
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
765765
# tag is left empty.
766766

767-
LAYOUT_FILE =
767+
LAYOUT_FILE = docs/DoxygenLayout.xml
768768

769769
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
770770
# the reference definitions. This must be a list of .bib files. The .bib
@@ -1316,7 +1316,7 @@ HTML_DYNAMIC_SECTIONS = YES
13161316
# Minimum value: 0, maximum value: 9999, default value: 100.
13171317
# This tag requires that the tag GENERATE_HTML is set to YES.
13181318

1319-
HTML_INDEX_NUM_ENTRIES = 100
1319+
HTML_INDEX_NUM_ENTRIES = 0
13201320

13211321
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
13221322
# generated that can be used as input for Apple's Xcode 3 integrated development

‎docs/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ set_local_dist (docs_DIST_local
2323
${docs_DIST_mds}
2424
${docs_DIST_htmls}
2525
${docs_DIST_tomls}
26+
DoxygenLayout.xml
2627
layouts/.readme
2728
static/.readme
2829
)

‎docs/DoxygenLayout.xml

Lines changed: 226 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,226 @@
1+
<doxygenlayout version="1.0">
2+
<!-- Generated by doxygen 1.9.1 -->
3+
<!-- Navigation index tabs for HTML output -->
4+
<navindex>
5+
<tab type="mainpage" visible="yes" title=""/>
6+
<tab type="files" visible="yes" title="">
7+
<tab type="filelist" visible="yes" title="" intro=""/>
8+
<tab type="globals" visible="yes" title="" intro=""/>
9+
</tab>
10+
<tab type="namespaces" visible="yes" title="">
11+
<tab type="namespacelist" visible="yes" title="" intro=""/>
12+
<tab type="namespacemembers" visible="yes" title="" intro=""/>
13+
</tab>
14+
<tab type="classes" visible="yes" title="">
15+
<tab type="classlist" visible="yes" title="" intro=""/>
16+
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
17+
<tab type="hierarchy" visible="yes" title="" intro=""/>
18+
<tab type="classmembers" visible="yes" title="" intro=""/>
19+
</tab>
20+
<tab type="modules" visible="yes" title="Groups" intro="Pages documenting groups of related entities."/>
21+
<tab type="pages" visible="yes" title="Topics" intro="Pages documenting topics related to the API."/>
22+
<tab type="interfaces" visible="no" title="Unused">
23+
<tab type="interfacelist" visible="yes" title="" intro=""/>
24+
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
25+
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
26+
</tab>
27+
<tab type="structs" visible="no" title="Unused">
28+
<tab type="structlist" visible="yes" title="" intro=""/>
29+
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
30+
</tab>
31+
<tab type="exceptions" visible="no" title="Unused">
32+
<tab type="exceptionlist" visible="yes" title="" intro=""/>
33+
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
34+
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
35+
</tab>
36+
<tab type="examples" visible="no" title="Unused" intro=""/>
37+
</navindex>
38+
39+
<!-- Layout definition for a class page -->
40+
<class>
41+
<briefdescription visible="no"/>
42+
<detaileddescription title="Description"/>
43+
<usedfiles visible="$SHOW_USED_FILES"/>
44+
<includes visible="$SHOW_INCLUDE_FILES"/>
45+
<inheritancegraph visible="$CLASS_GRAPH"/>
46+
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
47+
<memberdecl>
48+
<nestedclasses visible="yes" title=""/>
49+
<publictypes title=""/>
50+
<services title=""/>
51+
<interfaces title=""/>
52+
<publicslots title=""/>
53+
<signals title=""/>
54+
<publicmethods title=""/>
55+
<publicstaticmethods title=""/>
56+
<publicattributes title=""/>
57+
<publicstaticattributes title=""/>
58+
<protectedtypes title=""/>
59+
<protectedslots title=""/>
60+
<protectedmethods title=""/>
61+
<protectedstaticmethods title=""/>
62+
<protectedattributes title=""/>
63+
<protectedstaticattributes title=""/>
64+
<packagetypes title=""/>
65+
<packagemethods title=""/>
66+
<packagestaticmethods title=""/>
67+
<packageattributes title=""/>
68+
<packagestaticattributes title=""/>
69+
<properties title=""/>
70+
<events title=""/>
71+
<privatetypes title=""/>
72+
<privateslots title=""/>
73+
<privatemethods title=""/>
74+
<privatestaticmethods title=""/>
75+
<privateattributes title=""/>
76+
<privatestaticattributes title=""/>
77+
<friends title=""/>
78+
<related title="" subtitle=""/>
79+
<membergroups visible="yes"/>
80+
</memberdecl>
81+
<memberdef>
82+
<inlineclasses title=""/>
83+
<typedefs title=""/>
84+
<enums title=""/>
85+
<services title=""/>
86+
<interfaces title=""/>
87+
<constructors title=""/>
88+
<functions title=""/>
89+
<related title=""/>
90+
<variables title=""/>
91+
<properties title=""/>
92+
<events title=""/>
93+
</memberdef>
94+
<allmemberslink visible="yes"/>
95+
<authorsection visible="yes"/>
96+
</class>
97+
98+
<!-- Layout definition for a namespace page -->
99+
<namespace>
100+
<briefdescription visible="no"/>
101+
<detaileddescription title="Description"/>
102+
<memberdecl>
103+
<nestednamespaces visible="yes" title=""/>
104+
<constantgroups visible="yes" title=""/>
105+
<interfaces visible="yes" title=""/>
106+
<classes visible="yes" title=""/>
107+
<structs visible="yes" title=""/>
108+
<exceptions visible="yes" title=""/>
109+
<typedefs title=""/>
110+
<sequences title=""/>
111+
<dictionaries title=""/>
112+
<enums title=""/>
113+
<functions title=""/>
114+
<variables title=""/>
115+
<membergroups visible="yes"/>
116+
</memberdecl>
117+
<memberdef>
118+
<inlineclasses title=""/>
119+
<typedefs title=""/>
120+
<sequences title=""/>
121+
<dictionaries title=""/>
122+
<enums title=""/>
123+
<functions title=""/>
124+
<variables title=""/>
125+
</memberdef>
126+
<authorsection visible="yes"/>
127+
</namespace>
128+
129+
<!-- Layout definition for a file page -->
130+
<file>
131+
<briefdescription visible="no"/>
132+
<detaileddescription title="Description"/>
133+
<includes visible="$SHOW_INCLUDE_FILES"/>
134+
<includegraph visible="$INCLUDE_GRAPH"/>
135+
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
136+
<sourcelink visible="yes"/>
137+
<memberdecl>
138+
<interfaces visible="yes" title=""/>
139+
<classes visible="yes" title=""/>
140+
<structs visible="yes" title=""/>
141+
<exceptions visible="yes" title=""/>
142+
<namespaces visible="yes" title=""/>
143+
<constantgroups visible="yes" title=""/>
144+
<defines title=""/>
145+
<typedefs title=""/>
146+
<sequences title=""/>
147+
<dictionaries title=""/>
148+
<enums title=""/>
149+
<functions title=""/>
150+
<variables title=""/>
151+
<membergroups visible="yes"/>
152+
</memberdecl>
153+
<memberdef>
154+
<inlineclasses title=""/>
155+
<defines title=""/>
156+
<typedefs title=""/>
157+
<sequences title=""/>
158+
<dictionaries title=""/>
159+
<enums title=""/>
160+
<functions title=""/>
161+
<variables title=""/>
162+
</memberdef>
163+
<authorsection/>
164+
</file>
165+
166+
<!-- Layout definition for a group page -->
167+
<group>
168+
<briefdescription visible="no"/>
169+
<detaileddescription title="Description"/>
170+
<groupgraph visible="$GROUP_GRAPHS"/>
171+
<memberdecl>
172+
<nestedgroups visible="yes" title=""/>
173+
<dirs visible="yes" title=""/>
174+
<files visible="yes" title=""/>
175+
<namespaces visible="yes" title=""/>
176+
<classes visible="yes" title=""/>
177+
<defines title=""/>
178+
<typedefs title=""/>
179+
<sequences title=""/>
180+
<dictionaries title=""/>
181+
<enums title=""/>
182+
<enumvalues title=""/>
183+
<functions title=""/>
184+
<variables title=""/>
185+
<signals title=""/>
186+
<publicslots title=""/>
187+
<protectedslots title=""/>
188+
<privateslots title=""/>
189+
<events title=""/>
190+
<properties title=""/>
191+
<friends title=""/>
192+
<membergroups visible="yes"/>
193+
</memberdecl>
194+
<memberdef>
195+
<pagedocs/>
196+
<inlineclasses title=""/>
197+
<defines title=""/>
198+
<typedefs title=""/>
199+
<sequences title=""/>
200+
<dictionaries title=""/>
201+
<enums title=""/>
202+
<enumvalues title=""/>
203+
<functions title=""/>
204+
<variables title=""/>
205+
<signals title=""/>
206+
<publicslots title=""/>
207+
<protectedslots title=""/>
208+
<privateslots title=""/>
209+
<events title=""/>
210+
<properties title=""/>
211+
<friends title=""/>
212+
</memberdef>
213+
<authorsection visible="yes"/>
214+
</group>
215+
216+
<!-- Layout definition for a directory page -->
217+
<directory>
218+
<briefdescription visible="no"/>
219+
<detaileddescription title="Description"/>
220+
<directorygraph visible="yes"/>
221+
<memberdecl>
222+
<dirs visible="yes"/>
223+
<files visible="yes"/>
224+
</memberdecl>
225+
</directory>
226+
</doxygenlayout>

‎src/mongocxx/include/mongocxx/v_noabi/mongocxx/client_session.hpp

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -219,8 +219,3 @@ class client_session {
219219
} // namespace mongocxx
220220

221221
#include <mongocxx/config/postlude.hpp>
222-
223-
///
224-
/// @example examples/mongocxx/client_session.cpp
225-
/// Use a mongocxx::v_noabi::client_session for a sequence of operations with causal consistency.
226-
///

‎src/mongocxx/include/mongocxx/v_noabi/mongocxx/uri.hpp

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,6 @@ namespace v_noabi {
3636
///
3737
/// Class representing a MongoDB connection string URI.
3838
///
39-
/// @todo CXX-2038 Use optionals for all option getters. Otherwise users cannot distinguish between
40-
/// a case of an empty option explicitly present in the URI and the option being omitted. Also
41-
/// change getters that return a std::string to return a string_view since a copy is not necessary.
42-
///
4339
/// @see https://www.mongodb.com/docs/manual/reference/connection-string/
4440
/// @see https://mongoc.org/libmongoc/current/mongoc_uri_t.html for more information on supported
4541
/// URI options.

0 commit comments

Comments
 (0)