Improve documentation briefs and misc. details #1311
Merged
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.
Miscellaneous improvements to API documentation following #1309. Primarily targets cleanup of the brief descriptions displayed on the "Class List" page.
Note
Doxygen seems to fail to generate a class description for a member of a using-declared class. Filed doxygen/doxygen#11326.
The current brief descriptions on the Class List page are not consistently "brief", often unnecessarily including parts of what should be a detailed description instead:
The changes in this PR update all brief descriptions to be more consistent in their format and be properly "brief" in their length:
When able, brief descriptions of auxiliary class types (e.g. "options") simply refer to their primary interface with which they are meant to be used to avoid redundancy and verbosity (e.g. "Used by X"). Redundant leads (e.g. "Class representing...", "Class used to...", etc.) are omitted to improve brevity of descriptions.
Some notable changes that go beyond brief description updates include:
MONGOCXX_DEPRECATED
+@deprecated
toauthentication_exception
, which is not used anywhere.@important
tomongocxx::v_noabi::pool
documenting it does not conform to the CMAP specification.@deprecated
tomongocxx::v_noabi::validation_criteria
given there is mostly unused + its primary interfaces (conversion to BSON) are already deprecated as well.