CXX-1660 Fix some doxygen warnings

Author: kevinAlbs

src/bsoncxx/exception/error_code.hpp

@@ -102,8 +102,8 @@ BSONCXX_API const std::error_category& BSONCXX_CALL error_category();
 ///
 /// Translate a bsoncxx::error_code into a std::error_code.
 ///
-/// @param an error from bsoncxx
-/// @return an error_code
+/// @param error An error from bsoncxx
+/// @return An error_code
 ///
 BSONCXX_INLINE std::error_code make_error_code(error_code error) {
     return {static_cast<int>(error), error_category()};

src/bsoncxx/json.hpp

@@ -46,6 +46,8 @@ enum class ExtendedJsonMode : std::uint8_t {
 ///
 /// @param view
 ///   A valid BSON document.
+/// @param mode
+///   An optional JSON representation mode.
 ///
 /// @throws bsoncxx::exception with error details if the conversion failed.
 ///

src/bsoncxx/validate.hpp

@@ -140,7 +140,7 @@ class BSONCXX_API validator {
     /// Verifies that document keys do not contain any '.' characters. The dot
     /// character is illegal in MongoDB keys.
     ///
-    /// @param check_dollar_keys
+    /// @param check_dot_keys
     ///   If true, keys containing '.' will be treated as invalid.
     ///
     void check_dot_keys(bool check_dot_keys);

src/mongocxx/logger.hpp

@@ -25,7 +25,7 @@ namespace mongocxx {
 MONGOCXX_INLINE_NAMESPACE_BEGIN
 
 ///
-/// The log level of a message passed to a @logger.
+/// The log level of a message passed to a mongocxx::logger.
 ///
 enum class log_level {
     k_error,
@@ -40,7 +40,7 @@ enum class log_level {
 ///
 /// Returns a stringification of the given log level.
 ///
-/// @param rhs
+/// @param level
 ///   The type to stringify.
 ///
 /// @return a std::string representation of the type.

src/mongocxx/model/write.hpp

@@ -32,37 +32,37 @@ MONGOCXX_INLINE_NAMESPACE_BEGIN
 namespace model {
 
 ///
-/// Models a single write operation within a @bulk_write.
+/// Models a single write operation within a mongocxx::bulk_write.
 ///
 class MONGOCXX_API write {
    public:
     ///
-    /// Constructs a write from an @insert_one.
+    /// Constructs a write from a model::insert_one.
     ///
     write(insert_one value);
 
     ///
-    /// Constructs a write from an @update_one.
+    /// Constructs a write from a model::update_one.
     ///
     write(update_one value);
 
     ///
-    /// Constructs a write from an @update_many.
+    /// Constructs a write from a model::update_many.
     ///
     write(update_many value);
 
     ///
-    /// Constructs a write from a @delete_one.
+    /// Constructs a write from a model::delete_one.
     ///
     write(delete_one value);
 
     ///
-    /// Constructs a write from a @delete_many.
+    /// Constructs a write from a model::delete_many.
     ///
     write(delete_many value);
 
     ///
-    /// Constructs a write from a @replace_one.
+    /// Constructs a write from a model::replace_one.
     ///
     write(replace_one value);
 
@@ -91,43 +91,43 @@ class MONGOCXX_API write {
     write_type type() const;
 
     ///
-    /// Accesses the write as an @insert_one. It is illegal to call
-    /// this method if the return of @type (above) does not indicate
+    /// Accesses the write as a model::insert_one. It is illegal to call
+    /// this method if the return of type() does not indicate
     /// that this object currently contains the applicable type.
     ///
     const insert_one& get_insert_one() const;
 
     ///
-    /// Accesses the write as an @update_one. It is illegal to call
-    /// this method if the return of @type (above) does not indicate
+    /// Accesses the write as an model::update_one. It is illegal to call
+    /// this method if the return of type() does not indicate
     /// that this object currently contains the applicable type.
     ///
     const update_one& get_update_one() const;
 
     ///
-    /// Accesses the write as an @update_many. It is illegal to call
-    /// this method if the return of @type (above) does not indicate
+    /// Accesses the write as an model::update_many. It is illegal to call
+    /// this method if the return of type() does not indicate
     /// that this object currently contains the applicable type.
     ///
     const update_many& get_update_many() const;
 
     ///
-    /// Accesses the write as a @delete_one. It is illegal to call
-    /// this method if the return of @type (above) does not indicate
+    /// Accesses the write as a model::delete_one. It is illegal to call
+    /// this method if the return of type() does not indicate
     /// that this object currently contains the applicable type.
     ///
     const delete_one& get_delete_one() const;
 
     ///
-    /// Accesses the write as a @delete_many. It is illegal to call
-    /// this method if the return of @type (above) does not indicate
+    /// Accesses the write as a model::delete_many. It is illegal to call
+    /// this method if the return of type() does not indicate
     /// that this object currently contains the applicable type.
     ///
     const delete_many& get_delete_many() const;
 
     ///
-    /// Accesses the write as a @replace_one. It is illegal to call
-    /// this method if the return of @type (above) does not indicate
+    /// Accesses the write as a model::replace_one. It is illegal to call
+    /// this method if the return of type() does not indicate
     /// that this object currently contains the applicable type.
     ///
     const replace_one& get_replace_one() const;

src/mongocxx/options/apm.hpp

@@ -85,7 +85,7 @@ class MONGOCXX_API apm {
     /// Set the command succeeded monitoring callback. The callback takes a reference to a
     /// command_succeeded_event which will only contain valid data for the duration of the callback.
     ///
-    /// @param command_failed
+    /// @param command_succeeded
     ///   The command succeeded monitoring callback.
     ///
     /// @return
@@ -286,7 +286,7 @@ class MONGOCXX_API apm {
     /// heartbeat_succeeded_event which will only contain valid data for the duration of the
     /// callback.
     ///
-    /// @param heartbeat_failed
+    /// @param heartbeat_succeeded
     ///   The heartbeat succeeded monitoring callback.
     ///
     /// @return

src/mongocxx/options/change_stream.hpp

@@ -149,7 +149,7 @@ class MONGOCXX_API change_stream {
     /// Specifies the logical starting point for the new change stream. Changes are returned at or
     /// after the specified operation time.
     ///
-    /// @param operation_time
+    /// @param timestamp
     ///   The starting operation time.
     ///
     /// @return

src/mongocxx/options/create_collection.hpp

@@ -191,7 +191,7 @@ class MONGOCXX_API create_collection {
     ///
     /// @note This option is currently only available with the WiredTiger storage engine.
     ///
-    /// @param storage_engine_options
+    /// @param storage_engine_opts
     ///   Configuration options specific to the storage engine.
     ///
     /// @return

src/mongocxx/options/index.hpp

@@ -240,7 +240,7 @@ class MONGOCXX_API index {
     ///
     /// Sets the index version.
     ///
-    /// @param version
+    /// @param v
     ///   The index version.
     ///
     /// @return

src/mongocxx/pipeline.hpp

@@ -410,7 +410,7 @@ class MONGOCXX_API pipeline {
     /// @see https://docs.mongodb.com/master/reference/operator/aggregation/unwind/
     ///
     /// @param unwind_args
-    ///   The specification for the unwind operation.  The required field @path must be included.
+    ///   The specification for the unwind operation.  The required field path must be included.
     ///
     /// @return
     ///   A reference to the object on which this member function is being called.  This facilitates