CXX-3070 Address -Wdocumentation Clang warnings#1175
Merged
eramongodb merged 1 commit intomongodb:masterfrom Jul 24, 2024
Merged
CXX-3070 Address -Wdocumentation Clang warnings#1175eramongodb merged 1 commit intomongodb:masterfrom
eramongodb merged 1 commit intomongodb:masterfrom
Conversation
kevinAlbs
approved these changes
Jul 24, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Resolves CXX-3070.
-Wdocumentation
Notable fixes include:
namein@param name.-Wdocumentation-deprecated-sync
Some of these warnings were addressed by changing the
@deprecatedto a@warning, such as when the command is referring to an entity other than what is currently being documented.However, these warnings are for the most part ignored and left unaddressed. Applying
[[deprecated]]or*_DEPRECATED(from the export header) to relevant entities produces too many-Wdeprecated-declarationswarnings. This currently applies to:bsoncxx::v_noabi::types::b_undefined(type)bsoncxx::v_noabi::types::b_dbpointer(type)bsoncxx::v_noabi::types::b_symbol(type)mongocxx::v_noabi::database::create_collection_deprecated(member function)mongocxx::v_noabi::options::find::comment(member functions (2))We may revisit these another time with a methodology that doesn't trigger so many
-Wdeprecated-declarationswarnings within our own code (or in users' code despite no direct usage).