Annotated all internal packages #1818
Merged
Conversation
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
JAVA-5975
|
Changed the copy and paste for the javadocs and annotated all the core drivers libraries. |
There was a problem hiding this comment.
Pull Request Overview
This PR standardizes the annotation and documentation of internal packages across the MongoDB Java driver to clearly mark them as internal functionality that may change at any time.
- Adds
@Internalannotation to all internal package declarations - Standardizes package documentation to use consistent warning message
- Removes package-specific documentation in favor of generic internal package warning
Reviewed Changes
Copilot reviewed 34 out of 34 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| driver-sync/.../internal/package-info.java | Added @internal annotation and standard warning message |
| driver-reactive-streams/.../internal/vault/package-info.java | Replaced specific documentation with standard warning and added @internal annotation |
| driver-reactive-streams/.../internal/package-info.java | Replaced specific documentation with standard warning and added @internal annotation |
| driver-reactive-streams/.../internal/gridfs/package-info.java | Replaced specific documentation with standard warning and added @internal annotation |
| driver-reactive-streams/.../internal/crypt/package-info.java | Replaced specific documentation with standard warning and added @internal annotation |
| driver-core/.../internal/validator/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/time/package-info.java | Replaced specific documentation with standard warning and added @internal annotation |
| driver-core/.../internal/thread/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/session/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/selector/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/package-info.java | Added standard warning message and @internal annotation |
| driver-core/.../internal/operation/retry/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/operation/package-info.java | Replaced specific documentation with standard warning and added @internal annotation |
| driver-core/.../internal/logging/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/inject/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/function/package-info.java | Added standard warning message and @internal annotation |
| driver-core/.../internal/event/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/dns/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/diagnostics/logging/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/connection/tlschannel/package-info.java | Replaced detailed TLS Channel documentation with standard warning and added @internal annotation |
| driver-core/.../internal/connection/tlschannel/async/package-info.java | Replaced specific documentation with standard warning and added @internal annotation |
| driver-core/.../internal/connection/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/connection/netty/package-info.java | Replaced specific documentation with standard warning and added @internal annotation |
| driver-core/.../internal/client/vault/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/client/package-info.java | Replaced specific documentation with standard warning and added @internal annotation |
| driver-core/.../internal/client/model/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/client/model/changestream/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/client/model/bulk/package-info.java | Replaced specific documentation with standard warning and added @internal annotation |
| driver-core/.../internal/capi/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/bulk/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/binding/package-info.java | Replaced incorrect documentation with standard warning and added @internal annotation |
| driver-core/.../internal/authentication/package-info.java | Added standard warning message and @internal annotation |
| driver-core/.../internal/async/package-info.java | Added standard warning message and @internal annotation |
| driver-core/.../internal/async/function/package-info.java | Added standard warning message and @internal annotation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
nhachicha
approved these changes
Oct 9, 2025
|
|
||
| /** | ||
| * This package enables the usage of TLS Channel as an {@link | ||
| * java.nio.channels.AsynchronousByteChannel}. |
There was a problem hiding this comment.
Don't you want to keep the internal description though?
| * <p>In other words, a simple library that allows the programmer to have TLS using the same | ||
| * standard socket API used for plaintext, just like OpenSSL does for C, only for Java, filling a | ||
| * specially painful missing feature of the standard Java library. | ||
| * This package contains internal functionality that may change at any time. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
JAVA-5975