Skip to content

Commit 7d3f378

Browse files
authored
CXX-2745 apply precursor changes to Doxygen and CMake configs (#1166)
* doxygen: set SHOW_INCLUDE_FILES = NO * doxygen: set EXTRACT_LOCAL_CLASSES = NO * doxygen: add include prefix to INCLUDE_PATH * cmake: use file(GLOB_RECURSE) for header file lists * cmake: avoid repetition of source file lists * cmake: exclude macro guard headers in macro guard tests * doxygen: set CLASS_GRAPH = NO
1 parent 92a4811 commit 7d3f378

File tree

7 files changed

+42
-409
lines changed

7 files changed

+42
-409
lines changed

Doxyfile

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@ EXTRACT_STATIC = NO
507507
# for Java sources.
508508
# The default value is: YES.
509509

510-
EXTRACT_LOCAL_CLASSES = YES
510+
EXTRACT_LOCAL_CLASSES = NO
511511

512512
# This flag is only useful for Objective-C code. If set to YES, local methods,
513513
# which are defined in the implementation section but not in the interface are
@@ -604,7 +604,7 @@ HIDE_COMPOUND_REFERENCE= NO
604604
# the files that are included by a file in the documentation of that file.
605605
# The default value is: YES.
606606

607-
SHOW_INCLUDE_FILES = YES
607+
SHOW_INCLUDE_FILES = NO
608608

609609
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
610610
# grouped member an include statement to the documentation, telling the reader
@@ -2188,7 +2188,10 @@ SEARCH_INCLUDES = YES
21882188
# preprocessor.
21892189
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
21902190

2191-
INCLUDE_PATH = src/bsoncxx/include/bsoncxx/v_noabi
2191+
INCLUDE_PATH = src/bsoncxx/include/bsoncxx/v_noabi \
2192+
src/mongocxx/include/mongocxx/v_noabi \
2193+
src/bsoncxx/include \
2194+
src/mongocxx/include
21922195

21932196
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
21942197
# patterns (like *.h and *.hpp) to filter out the header-files in the
@@ -2355,7 +2358,7 @@ DOT_FONTPATH =
23552358
# The default value is: YES.
23562359
# This tag requires that the tag HAVE_DOT is set to YES.
23572360

2358-
CLASS_GRAPH = YES
2361+
CLASS_GRAPH = NO
23592362

23602363
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
23612364
# graph for each documented class showing the direct and indirect implementation

src/bsoncxx/include/CMakeLists.txt

Lines changed: 7 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -18,91 +18,13 @@ install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/
1818
FILES_MATCHING PATTERN "*.hpp"
1919
)
2020

21+
file(GLOB_RECURSE bsoncxx_include_headers
22+
RELATIVE ${CMAKE_CURRENT_SOURCE_DIR}
23+
CONFIGURE_DEPENDS
24+
"*.hpp"
25+
)
26+
2127
set_dist_list(src_bsoncxx_include_DIST
2228
CMakeLists.txt
23-
bsoncxx/v_noabi/bsoncxx/array/element-fwd.hpp
24-
bsoncxx/v_noabi/bsoncxx/array/element.hpp
25-
bsoncxx/v_noabi/bsoncxx/array/value-fwd.hpp
26-
bsoncxx/v_noabi/bsoncxx/array/value.hpp
27-
bsoncxx/v_noabi/bsoncxx/array/view_or_value.hpp
28-
bsoncxx/v_noabi/bsoncxx/array/view-fwd.hpp
29-
bsoncxx/v_noabi/bsoncxx/array/view.hpp
30-
bsoncxx/v_noabi/bsoncxx/builder/basic/array-fwd.hpp
31-
bsoncxx/v_noabi/bsoncxx/builder/basic/array.hpp
32-
bsoncxx/v_noabi/bsoncxx/builder/basic/document-fwd.hpp
33-
bsoncxx/v_noabi/bsoncxx/builder/basic/document.hpp
34-
bsoncxx/v_noabi/bsoncxx/builder/basic/helpers.hpp
35-
bsoncxx/v_noabi/bsoncxx/builder/basic/impl.hpp
36-
bsoncxx/v_noabi/bsoncxx/builder/basic/kvp.hpp
37-
bsoncxx/v_noabi/bsoncxx/builder/basic/sub_array-fwd.hpp
38-
bsoncxx/v_noabi/bsoncxx/builder/basic/sub_array.hpp
39-
bsoncxx/v_noabi/bsoncxx/builder/basic/sub_document-fwd.hpp
40-
bsoncxx/v_noabi/bsoncxx/builder/basic/sub_document.hpp
41-
bsoncxx/v_noabi/bsoncxx/builder/concatenate-fwd.hpp
42-
bsoncxx/v_noabi/bsoncxx/builder/concatenate.hpp
43-
bsoncxx/v_noabi/bsoncxx/builder/core-fwd.hpp
44-
bsoncxx/v_noabi/bsoncxx/builder/core.hpp
45-
bsoncxx/v_noabi/bsoncxx/builder/list-fwd.hpp
46-
bsoncxx/v_noabi/bsoncxx/builder/list.hpp
47-
bsoncxx/v_noabi/bsoncxx/builder/stream/array_context-fwd.hpp
48-
bsoncxx/v_noabi/bsoncxx/builder/stream/array_context.hpp
49-
bsoncxx/v_noabi/bsoncxx/builder/stream/array-fwd.hpp
50-
bsoncxx/v_noabi/bsoncxx/builder/stream/array.hpp
51-
bsoncxx/v_noabi/bsoncxx/builder/stream/closed_context-fwd.hpp
52-
bsoncxx/v_noabi/bsoncxx/builder/stream/closed_context.hpp
53-
bsoncxx/v_noabi/bsoncxx/builder/stream/document-fwd.hpp
54-
bsoncxx/v_noabi/bsoncxx/builder/stream/document.hpp
55-
bsoncxx/v_noabi/bsoncxx/builder/stream/helpers-fwd.hpp
56-
bsoncxx/v_noabi/bsoncxx/builder/stream/helpers.hpp
57-
bsoncxx/v_noabi/bsoncxx/builder/stream/key_context-fwd.hpp
58-
bsoncxx/v_noabi/bsoncxx/builder/stream/key_context.hpp
59-
bsoncxx/v_noabi/bsoncxx/builder/stream/single_context-fwd.hpp
60-
bsoncxx/v_noabi/bsoncxx/builder/stream/single_context.hpp
61-
bsoncxx/v_noabi/bsoncxx/builder/stream/value_context-fwd.hpp
62-
bsoncxx/v_noabi/bsoncxx/builder/stream/value_context.hpp
63-
bsoncxx/v_noabi/bsoncxx/config/compiler.hpp
64-
bsoncxx/v_noabi/bsoncxx/config/postlude.hpp
65-
bsoncxx/v_noabi/bsoncxx/config/prelude.hpp
66-
bsoncxx/v_noabi/bsoncxx/config/util.hpp
67-
bsoncxx/v_noabi/bsoncxx/decimal128-fwd.hpp
68-
bsoncxx/v_noabi/bsoncxx/decimal128.hpp
69-
bsoncxx/v_noabi/bsoncxx/document/element-fwd.hpp
70-
bsoncxx/v_noabi/bsoncxx/document/element.hpp
71-
bsoncxx/v_noabi/bsoncxx/document/value-fwd.hpp
72-
bsoncxx/v_noabi/bsoncxx/document/value.hpp
73-
bsoncxx/v_noabi/bsoncxx/document/view_or_value.hpp
74-
bsoncxx/v_noabi/bsoncxx/document/view-fwd.hpp
75-
bsoncxx/v_noabi/bsoncxx/document/view.hpp
76-
bsoncxx/v_noabi/bsoncxx/enums/binary_sub_type.hpp
77-
bsoncxx/v_noabi/bsoncxx/enums/type.hpp
78-
bsoncxx/v_noabi/bsoncxx/exception/error_code-fwd.hpp
79-
bsoncxx/v_noabi/bsoncxx/exception/error_code.hpp
80-
bsoncxx/v_noabi/bsoncxx/exception/exception-fwd.hpp
81-
bsoncxx/v_noabi/bsoncxx/exception/exception.hpp
82-
bsoncxx/v_noabi/bsoncxx/json-fwd.hpp
83-
bsoncxx/v_noabi/bsoncxx/json.hpp
84-
bsoncxx/v_noabi/bsoncxx/oid-fwd.hpp
85-
bsoncxx/v_noabi/bsoncxx/oid.hpp
86-
bsoncxx/v_noabi/bsoncxx/stdx/make_unique.hpp
87-
bsoncxx/v_noabi/bsoncxx/stdx/operators.hpp
88-
bsoncxx/v_noabi/bsoncxx/stdx/optional.hpp
89-
bsoncxx/v_noabi/bsoncxx/stdx/string_view.hpp
90-
bsoncxx/v_noabi/bsoncxx/stdx/type_traits.hpp
91-
bsoncxx/v_noabi/bsoncxx/string/to_string.hpp
92-
bsoncxx/v_noabi/bsoncxx/string/view_or_value-fwd.hpp
93-
bsoncxx/v_noabi/bsoncxx/string/view_or_value.hpp
94-
bsoncxx/v_noabi/bsoncxx/types-fwd.hpp
95-
bsoncxx/v_noabi/bsoncxx/types.hpp
96-
bsoncxx/v_noabi/bsoncxx/types/bson_value/make_value.hpp
97-
bsoncxx/v_noabi/bsoncxx/types/bson_value/value-fwd.hpp
98-
bsoncxx/v_noabi/bsoncxx/types/bson_value/value.hpp
99-
bsoncxx/v_noabi/bsoncxx/types/bson_value/view_or_value.hpp
100-
bsoncxx/v_noabi/bsoncxx/types/bson_value/view-fwd.hpp
101-
bsoncxx/v_noabi/bsoncxx/types/bson_value/view.hpp
102-
bsoncxx/v_noabi/bsoncxx/types/value.hpp
103-
bsoncxx/v_noabi/bsoncxx/util/functor.hpp
104-
bsoncxx/v_noabi/bsoncxx/validate-fwd.hpp
105-
bsoncxx/v_noabi/bsoncxx/validate.hpp
106-
bsoncxx/v_noabi/bsoncxx/view_or_value-fwd.hpp
107-
bsoncxx/v_noabi/bsoncxx/view_or_value.hpp
29+
${bsoncxx_include_headers}
10830
)

src/bsoncxx/lib/CMakeLists.txt

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
list(APPEND bsoncxx_sources
15+
set(bsoncxx_sources_v_noabi
1616
bsoncxx/v_noabi/bsoncxx/array/element.cpp
1717
bsoncxx/v_noabi/bsoncxx/array/value.cpp
1818
bsoncxx/v_noabi/bsoncxx/array/view.cpp
@@ -31,6 +31,10 @@ list(APPEND bsoncxx_sources
3131
bsoncxx/v_noabi/bsoncxx/types/bson_value/view.cpp
3232
bsoncxx/v_noabi/bsoncxx/validate.cpp
3333
)
34+
35+
list(APPEND bsoncxx_sources
36+
${bsoncxx_sources_v_noabi}
37+
)
3438
list(TRANSFORM bsoncxx_sources PREPEND "${CMAKE_CURRENT_SOURCE_DIR}/")
3539
set(bsoncxx_sources "${bsoncxx_sources}" PARENT_SCOPE)
3640

@@ -64,35 +68,19 @@ endif()
6468

6569
set_dist_list(src_bsoncxx_lib_DIST
6670
CMakeLists.txt
67-
bsoncxx/v_noabi/bsoncxx/array/element.cpp
68-
bsoncxx/v_noabi/bsoncxx/array/value.cpp
69-
bsoncxx/v_noabi/bsoncxx/array/view.cpp
70-
bsoncxx/v_noabi/bsoncxx/builder/core.cpp
71+
${bsoncxx_sources_v_noabi}
7172
bsoncxx/v_noabi/bsoncxx/config/config.hpp.in
7273
bsoncxx/v_noabi/bsoncxx/config/private/config.hh.in
7374
bsoncxx/v_noabi/bsoncxx/config/private/postlude.hh
7475
bsoncxx/v_noabi/bsoncxx/config/private/prelude.hh
7576
bsoncxx/v_noabi/bsoncxx/config/version.hpp.in
76-
bsoncxx/v_noabi/bsoncxx/decimal128.cpp
77-
bsoncxx/v_noabi/bsoncxx/document/element.cpp
78-
bsoncxx/v_noabi/bsoncxx/document/value.cpp
79-
bsoncxx/v_noabi/bsoncxx/document/view.cpp
80-
bsoncxx/v_noabi/bsoncxx/exception/error_code.cpp
81-
bsoncxx/v_noabi/bsoncxx/json.cpp
82-
bsoncxx/v_noabi/bsoncxx/oid.cpp
8377
bsoncxx/v_noabi/bsoncxx/private/b64_ntop.hh
8478
bsoncxx/v_noabi/bsoncxx/private/helpers.hh
85-
bsoncxx/v_noabi/bsoncxx/private/itoa.cpp
8679
bsoncxx/v_noabi/bsoncxx/private/itoa.hh
8780
bsoncxx/v_noabi/bsoncxx/private/libbson.hh
8881
bsoncxx/v_noabi/bsoncxx/private/stack.hh
8982
bsoncxx/v_noabi/bsoncxx/private/suppress_deprecation_warnings.hh
90-
bsoncxx/v_noabi/bsoncxx/string/view_or_value.cpp
9183
bsoncxx/v_noabi/bsoncxx/test_util/export_for_testing.hh
92-
bsoncxx/v_noabi/bsoncxx/types.cpp
9384
bsoncxx/v_noabi/bsoncxx/types/bson_value/private/value.hh
94-
bsoncxx/v_noabi/bsoncxx/types/bson_value/value.cpp
95-
bsoncxx/v_noabi/bsoncxx/types/bson_value/view.cpp
9685
bsoncxx/v_noabi/bsoncxx/types/private/convert.hh
97-
bsoncxx/v_noabi/bsoncxx/validate.cpp
9886
)

src/bsoncxx/test/CMakeLists.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,9 @@ if(ENABLE_MACRO_GUARD_TESTS)
122122
"lib/*.hh" # Private headers.
123123
"test/*.hh" # Test headers.
124124
EXCLUDE_REGEXES
125-
"(include|lib)/bsoncxx/v.*/config/.*" # Config headers.
126-
"include/bsoncxx/v_noabi/bsoncxx/enums/.*" # X macro headers.
125+
"(include|lib)/.*/(prelude|postlude)\.(hpp|hh)" # Macro guard headers.
126+
"(include|lib)/bsoncxx/v_noabi/bsoncxx/config/.*" # v_noabi config headers.
127+
"include/bsoncxx/v_noabi/bsoncxx/enums/.*" # v_noabi X-macro headers.
127128
".*_symbols.hh" # Symbol headers.
128129
)
129130
endif()

0 commit comments

Comments
 (0)