CXX-3102 Remove use of BSONCXX_ENUM in public headers #1207
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.
Resolves CXX-3102.
The X macro headers under
bsoncxx/v_noabi/enum/
have long cause trouble with Doxygen documentation.These troubles have worsened following #1182, especially in enumerations:
These are in addition to numerous functions and enumerators which are not properly documented, e.g.
k_need_element_type_k_*
andk_cannot_append_*
error codes:as well as ctor overloads for
bsoncxx::v_noabi::types::bson_value::value
andbsoncxx::v_noabi::types::bson_value::view
.This PR proposes replacing all use of
BSONCXX_ENUM
(specifically the X macro headers themselves) in favor of fully expanding and properly documenting each BSON type and binary subtype. The X macro headers may still be used in internal code which does not require API documentation for convenience.The examples shown above are fixed to looks as follows: