CXX-3070 Address -Wdocumentation Clang warnings

[eramongodb]

Summary

Resolves CXX-3070.

-Wdocumentation

Notable fixes include:

• Misplacement of type aliases between a function and its intended documentation.
• Incorrect name in @param name.
• Redundant commands without useful documentation.

-Wdocumentation-deprecated-sync

Some of these warnings were addressed by changing the @deprecated to 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-declarations warnings. 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-declarations warnings within our own code (or in users' code despite no direct usage).