Skip to content

Commit d7a60d7

Browse files
committed
doxygen: address missing enum member documentation warnings
1 parent 241ae71 commit d7a60d7

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
@@ -30,13 +30,13 @@ namespace v_noabi {
3030
/// The log level of a message passed to a mongocxx::v_noabi::logger.
3131
///
3232
enum class log_level {
33-
k_error,
34-
k_critical,
35-
k_warning,
36-
k_message,
37-
k_info,
38-
k_debug,
39-
k_trace,
33+
k_error, ///< Log Level Error.
34+
k_critical, ///< Log Level Critical.
35+
k_warning, ///< Log Level Warning.
36+
k_message, ///< Log Level Message.
37+
k_info, ///< Log Level Info.
38+
k_debug, ///< Log Level Debug.
39+
k_trace, ///< Log Level Trace.
4040
};
4141

4242
///

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
@@ -33,12 +33,17 @@ namespace options {
3333
///
3434
/// Class representing options for server API.
3535
///
36+
/// @see @li [Stable API (MongoDB
37+
/// Manual)](https://www.mongodb.com/docs/manual/reference/stable-api/)
38+
///
3639
class server_api {
3740
public:
3841
///
3942
/// Enum representing the possible values for server API version.
4043
///
41-
enum class version { k_version_1 };
44+
enum class version {
45+
k_version_1, ///< Stable API Version 1.
46+
};
4247

4348
///
4449
/// 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
@@ -51,23 +51,29 @@ namespace v_noabi {
5151
/// a single document. Note that writes must be made with majority write concern in order for reads
5252
/// to be linearizable.
5353
///
54-
/// @see https://www.mongodb.com/docs/manual/reference/read-concern/
54+
/// @see @li [Read Concern (MongoDB
55+
/// Manual)](https://www.mongodb.com/docs/manual/reference/read-concern/)
5556
///
5657
class read_concern {
5758
public:
5859
///
59-
/// A class to represent the read concern level.
60+
/// A class to represent the read concern level for read operations.
6061
///
61-
/// @see https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels
62+
/// @see @parblock
63+
/// @li [Read Concern Levels (MongoDB
64+
/// Manual)](https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels)
65+
/// @li [Default MongoDB Read Concerns/Write Concerns (MongoDB
66+
/// Manual)](https://www.mongodb.com/docs/manual/reference/mongodb-defaults/#read-concern)
67+
/// @endparblock
6268
///
6369
enum class level {
64-
k_local,
65-
k_majority,
66-
k_linearizable,
67-
k_server_default,
68-
k_unknown,
69-
k_available,
70-
k_snapshot
70+
k_local, ///< Represent read concern level "local".
71+
k_majority, ///< Represent read concern level "majority".
72+
k_linearizable, ///< Represent read concern level "linearizable".
73+
k_server_default, ///< Represent the server's default read concern level.
74+
k_unknown, ///< Represent an unknown read concern level.
75+
k_available, ///< Represent read concern level "available".
76+
k_snapshot ///< Represent read concern level "snapshot".
7177
};
7278

7379
///

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

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

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

103101
///

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

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

6780
///
6881
/// Constructs a new write_concern.

0 commit comments

Comments
 (0)