CXX-3069 document headers and root namespace redeclarations (mongocxx) (#1184)

* Add missing documentation for mongocxx::stdx

* CXX-3069 document headers and redeclarations (mongocxx)

Author: eramongodb

src/mongocxx/include/mongocxx/fwd.hpp

@@ -76,3 +76,14 @@
 /// @namespace mongocxx::result::gridfs
 /// Declares entities representing the result of GridFS commands.
 ///
+
+///
+/// @namespace mongocxx::stdx
+/// Redeclares @ref bsoncxx C++17 standard library polyfills in the @ref mongocxx library namespace
+/// for internal use.
+///
+/// @deprecated Use @ref bsoncxx::stdx instead.
+///
+/// @warning These redeclarations are for internal use only! Users should reference entities
+/// declared in @ref bsoncxx directly, not through @ref mongocxx.
+///

src/mongocxx/include/mongocxx/v_noabi/mongocxx/bulk_write-fwd.hpp

@@ -31,3 +31,19 @@ using ::mongocxx::v_noabi::bulk_write;
 }  // namespace mongocxx
 
 #include <mongocxx/config/postlude.hpp>
+
+///
+/// @file
+/// Declares @ref mongocxx::v_noabi::bulk_write.
+///
+
+#if defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
+
+namespace mongocxx {
+
+/// @ref mongocxx::v_noabi::bulk_write
+class bulk_write {};
+
+}  // namespace mongocxx
+
+#endif  // defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)

src/mongocxx/include/mongocxx/v_noabi/mongocxx/bulk_write.hpp

@@ -117,3 +117,8 @@ class bulk_write {
 }  // namespace mongocxx
 
 #include <mongocxx/config/postlude.hpp>
+
+///
+/// @file
+/// Provides @ref mongocxx::v_noabi::bulk_write.
+///

src/mongocxx/include/mongocxx/v_noabi/mongocxx/change_stream-fwd.hpp

@@ -31,3 +31,19 @@ using ::mongocxx::v_noabi::change_stream;
 }  // namespace mongocxx
 
 #include <mongocxx/config/postlude.hpp>
+
+///
+/// @file
+/// Declares @ref mongocxx::v_noabi::change_stream.
+///
+
+#if defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
+
+namespace mongocxx {
+
+/// @ref mongocxx::v_noabi::change_stream
+class change_stream {};
+
+}  // namespace mongocxx
+
+#endif  // defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)

src/mongocxx/include/mongocxx/v_noabi/mongocxx/change_stream.hpp

@@ -221,3 +221,8 @@ class change_stream::iterator {
 }  // namespace mongocxx
 
 #include <mongocxx/config/postlude.hpp>
+
+///
+/// @file
+/// Provides @ref mongocxx::v_noabi::change_stream.
+///

src/mongocxx/include/mongocxx/v_noabi/mongocxx/client-fwd.hpp

@@ -31,3 +31,19 @@ using ::mongocxx::v_noabi::client;
 }  // namespace mongocxx
 
 #include <mongocxx/config/postlude.hpp>
+
+///
+/// @file
+/// Declares @ref mongocxx::v_noabi::client.
+///
+
+#if defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
+
+namespace mongocxx {
+
+/// @ref mongocxx::v_noabi::client
+class client {};
+
+}  // namespace mongocxx
+
+#endif  // defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)

src/mongocxx/include/mongocxx/v_noabi/mongocxx/client.hpp

@@ -463,3 +463,8 @@ MONGOCXX_INLINE mongocxx::v_noabi::database client::operator[](
 }  // namespace mongocxx
 
 #include <mongocxx/config/postlude.hpp>
+
+///
+/// @file
+/// Provides @ref mongocxx::v_noabi::client.
+///

src/mongocxx/include/mongocxx/v_noabi/mongocxx/client_encryption-fwd.hpp

@@ -31,3 +31,19 @@ using ::mongocxx::v_noabi::client_encryption;
 }  // namespace mongocxx
 
 #include <mongocxx/config/postlude.hpp>
+
+///
+/// @file
+/// Declares @ref mongocxx::v_noabi::client_encryption.
+///
+
+#if defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
+
+namespace mongocxx {
+
+/// @ref mongocxx::v_noabi::client_encryption
+class client_encryption {};
+
+}  // namespace mongocxx
+
+#endif  // defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)

src/mongocxx/include/mongocxx/v_noabi/mongocxx/client_encryption.hpp

@@ -284,3 +284,8 @@ class client_encryption {
 }  // namespace mongocxx
 
 #include <mongocxx/config/postlude.hpp>
+
+///
+/// @file
+/// Provides @ref mongocxx::v_noabi::client_encryption.
+///

src/mongocxx/include/mongocxx/v_noabi/mongocxx/client_session-fwd.hpp

@@ -31,3 +31,19 @@ using ::mongocxx::v_noabi::client_session;
 }  // namespace mongocxx
 
 #include <mongocxx/config/postlude.hpp>
+
+///
+/// @file
+/// Declares @ref mongocxx::v_noabi::client_session.
+///
+
+#if defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
+
+namespace mongocxx {
+
+/// @ref mongocxx::v_noabi::client_session
+class client_session {};
+
+}  // namespace mongocxx
+
+#endif  // defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)