CXX-3108 Address missing enum member documentation Doxgyen warnings #1211
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses CXX-3108. Followup to #1185.
Sets
WARN_IF_UNDOC_ENUM_VAL = YES
(deferred by #1185), which enables warnings for undocumented enumerators.This revealed several enumerators in
mongocxx::v_noabi::error_code
which were incorrectly using//
instead of///
.Additionally, the enumerators of the following enumerations were completely undocumented (descriptions may have been present in the enumeration's documentation, but this of course does not generate enumerator tables or enable Doxygen references):
mongocxx::v_noabi::log_level
mongocxx::v_noabi::options::server_api::version
mongocxx::v_noabi::read_concern::level
mongocxx::v_noabi::write_concern::level
mongocxx::v_noabi::validation_criteria::validation_level
mongocxx::v_noabi::validation_criteria::validation_action
A drive-by documentation style improvement uses
@li
for@see
items for better formatting as well as Markdown-style titled links.The choice between
///
vs.///<
is simply: if///<
results in line-wrapping for one or more enumerators, use///
instead.