Skip to content

Commit 8244ec0

Browse files
saghmxdg
authored andcommitted
CXX-1176 Add doxygen tag for mongocxx and bsoncxx namespaces
Backported from CXX-1043.
1 parent fcce96d commit 8244ec0

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

src/bsoncxx/json.hpp

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,17 @@
2222

2323
#include <bsoncxx/config/prelude.hpp>
2424

25+
///
26+
/// Top level namespace for MongoDB C++ BSON functionality.
27+
///
2528
namespace bsoncxx {
2629
BSONCXX_INLINE_NAMESPACE_BEGIN
2730

31+
// Placing this variable between the `BSONCXX_INLINE_NAMESPACE_BEGIN` and the Doxygen documentation
32+
// for `to_json` suppressed the macro name from being shown as part of the return type in the
33+
// generated documentation pages.
34+
extern const bool k_silence_doxygen;
35+
2836
///
2937
/// Converts a BSON document to a JSON string.
3038
///

src/mongocxx/client.hpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727

2828
#include <mongocxx/config/prelude.hpp>
2929

30+
///
31+
/// Top level namespace for the MongoDB C++ driver.
32+
///
3033
namespace mongocxx {
3134
MONGOCXX_INLINE_NAMESPACE_BEGIN
3235

0 commit comments

Comments
 (0)