Skip to content

CXX-3069 document headers and root namespace redeclarations (mongocxx) #1184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 7, 2024

Conversation

eramongodb
Copy link
Contributor

Resolves CXX-3069. Followup to #1182.

Completes the addition of documentation of files and root namespace redeclarations for mongocxx using the same pattern as that for bsoncxx.

A couple changes beyond the regular include:

  • Added missing docs for mongocxx::stdx and mongocxx::v_noabi::stdx, which have been marked as deprecated in favor of directly using bsoncxx::stdx instead.
  • Updated deprecation notes for mongocxx::v_noabi::create_collection and mongocxx::v_noabi::ssl.
  • Added missing docs for some interfaces to resolve @ref links (e.g. validation_criteria comparison operators, typedefs and type aliases, etc.).

@eramongodb eramongodb requested a review from kevinAlbs August 5, 2024 19:22
@eramongodb eramongodb self-assigned this Aug 5, 2024
@eramongodb eramongodb merged commit 1c74ce0 into mongodb:master Aug 7, 2024
1 check was pending
@eramongodb eramongodb deleted the cxx-3069 branch August 7, 2024 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants