Skip to content

Commit 7695e4a

Browse files
committed
doxygen: address missing enum member documentation warnings
1 parent 310460f commit 7695e4a

File tree

6 files changed

+62
-40
lines changed

6 files changed

+62
-40
lines changed

src/mongocxx/include/mongocxx/v_noabi/mongocxx/exception/error_code.hpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,18 +97,18 @@ enum class error_code : std::int32_t {
9797
/// A moved-from mongocxx::v_noabi::options::transaction object has been used.
9898
k_invalid_transaction_options_object,
9999

100-
// A resource (server API handle, etc.) could not be created:
100+
/// A resource (server API handle, etc.) could not be created:
101101
k_create_resource_fail,
102102

103-
// A default-constructed or moved-from mongocxx::v_noabi::search_index_model object has been
104-
// used.
103+
/// A default-constructed or moved-from mongocxx::v_noabi::search_index_model object has been
104+
/// used.
105105
k_invalid_search_index_model,
106106

107-
// A default-constructed or moved-from mongocxx::v_noabi::search_index_view object has been
108-
// used.
107+
/// A default-constructed or moved-from mongocxx::v_noabi::search_index_view object has been
108+
/// used.
109109
k_invalid_search_index_view,
110110

111-
// Timed out while waiting for a client to be returned to the pool
111+
/// Timed out while waiting for a client to be returned to the pool
112112
k_pool_wait_queue_timeout,
113113

114114
// Add new constant string message to error_code.cpp as well!

src/mongocxx/include/mongocxx/v_noabi/mongocxx/logger.hpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ namespace v_noabi {
3131
/// The log level of a message passed to a mongocxx::v_noabi::logger.
3232
///
3333
enum class log_level {
34-
k_error,
35-
k_critical,
36-
k_warning,
37-
k_message,
38-
k_info,
39-
k_debug,
40-
k_trace,
34+
k_error, ///< Log Level Error.
35+
k_critical, ///< Log Level Critical.
36+
k_warning, ///< Log Level Warning.
37+
k_message, ///< Log Level Message.
38+
k_info, ///< Log Level Info.
39+
k_debug, ///< Log Level Debug.
40+
k_trace, ///< Log Level Trace.
4141
};
4242

4343
///

src/mongocxx/include/mongocxx/v_noabi/mongocxx/options/server_api.hpp

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,17 @@ namespace options {
3434
///
3535
/// Class representing options for server API.
3636
///
37+
/// @see @li [Stable API (MongoDB
38+
/// Manual)](https://www.mongodb.com/docs/manual/reference/stable-api/)
39+
///
3740
class server_api {
3841
public:
3942
///
4043
/// Enum representing the possible values for server API version.
4144
///
42-
enum class version { k_version_1 };
45+
enum class version {
46+
k_version_1, ///< Stable API Version 1.
47+
};
4348

4449
///
4550
/// Constructs a new server_api object.

src/mongocxx/include/mongocxx/v_noabi/mongocxx/read_concern.hpp

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,23 +52,29 @@ namespace v_noabi {
5252
/// a single document. Note that writes must be made with majority write concern in order for reads
5353
/// to be linearizable.
5454
///
55-
/// @see https://www.mongodb.com/docs/manual/reference/read-concern/
55+
/// @see @li [Read Concern (MongoDB
56+
/// Manual)](https://www.mongodb.com/docs/manual/reference/read-concern/)
5657
///
5758
class read_concern {
5859
public:
5960
///
60-
/// A class to represent the read concern level.
61+
/// A class to represent the read concern level for read operations.
6162
///
62-
/// @see https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels
63+
/// @see @parblock
64+
/// @li [Read Concern Levels (MongoDB
65+
/// Manual)](https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels)
66+
/// @li [Default MongoDB Read Concerns/Write Concerns (MongoDB
67+
/// Manual)](https://www.mongodb.com/docs/manual/reference/mongodb-defaults/#read-concern)
68+
/// @endparblock
6369
///
6470
enum class level {
65-
k_local,
66-
k_majority,
67-
k_linearizable,
68-
k_server_default,
69-
k_unknown,
70-
k_available,
71-
k_snapshot
71+
k_local, ///< Represent read concern level "local".
72+
k_majority, ///< Represent read concern level "majority".
73+
k_linearizable, ///< Represent read concern level "linearizable".
74+
k_server_default, ///< Represent the server's default read concern level.
75+
k_unknown, ///< Represent an unknown read concern level.
76+
k_available, ///< Represent read concern level "available".
77+
k_snapshot ///< Represent read concern level "snapshot".
7278
};
7379

7480
///

src/mongocxx/include/mongocxx/v_noabi/mongocxx/validation_criteria.hpp

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,15 @@ class validation_criteria {
5858
///
5959
/// A class to represent the different validation level options.
6060
///
61-
/// - k_off: Disable validation entirely.
62-
/// - k_moderate: Apply validation rules to inserts, and apply validation rules to updates only
63-
/// if the document to be updated already fulfills the validation criteria.
64-
/// - k_strict: Apply validation rules to all inserts and updates.
65-
///
6661
enum class validation_level {
62+
/// Disable validation entirely.
6763
k_off,
64+
65+
/// Apply validation rules to inserts, and apply validation rules to updates only if the
66+
/// document to be updated already fulfills the validation criteria.
6867
k_moderate,
68+
69+
/// Apply validation rules to all inserts and updates.
6970
k_strict,
7071
};
7172

@@ -92,13 +93,10 @@ class validation_criteria {
9293
///
9394
/// A class to represent the different validation action options.
9495
///
95-
/// - k_error: Reject any insertion or update that violates the validation criteria.
96-
/// - k_warn: Log any violations of the validation criteria, but allow the insertion or update
97-
/// to proceed.
98-
///
9996
enum class validation_action {
100-
k_error,
101-
k_warn,
97+
k_error, ///< Reject any insertion or update that violates the validation criteria.
98+
k_warn, ///< Log any violations of the validation criteria, but allow the insertion or
99+
///< update to proceed.
102100
};
103101

104102
///

src/mongocxx/include/mongocxx/v_noabi/mongocxx/write_concern.hpp

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,28 @@ namespace v_noabi {
5555
/// critical operations, clients can adjust the write concern to ensure better performance
5656
/// rather than persistence to the entire deployment.
5757
///
58-
/// @see https://www.mongodb.com/docs/manual/core/write-concern/
58+
/// @see @li [Write Concern (MongoDB
59+
/// Manual)](https://www.mongodb.com/docs/manual/core/write-concern/)
5960
///
6061
class write_concern {
6162
public:
6263
///
63-
/// A class to represent the special case values for write_concern::nodes.
64-
/// @see https://www.mongodb.com/docs/manual/reference/write-concern/#w-option
65-
///
66-
enum class level { k_default, k_majority, k_tag, k_unacknowledged, k_acknowledged };
64+
/// A class to represent the write concern level for write operations.
65+
///
66+
/// @see @parblock
67+
/// @li [Write Concern (MongoDB
68+
/// Manual)](https://www.mongodb.com/docs/manual/reference/write-concern/)
69+
/// @li [Default MongoDB Read Concerns/Write
70+
/// Concerns](https://www.mongodb.com/docs/manual/reference/mongodb-defaults/#write-concern)
71+
/// @endparblock
72+
///
73+
enum class level {
74+
k_default, ///< Represent the implicit default write concern.
75+
k_majority, ///< Represent write concern with `w: "majority"`.
76+
k_tag, ///< Represent write concern with `w: <custom write concern name>`.
77+
k_unacknowledged, ///< Represent write concern with `w: 0`.
78+
k_acknowledged, ///< Represent write concern with `w: 1`.
79+
};
6780

6881
///
6982
/// Constructs a new write_concern.

0 commit comments

Comments
 (0)