Annotated all internal packages #1818

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 @Internal annotation 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

nhachicha approved these changes

Oct 9, 2025

View reviewed changes

Copy link

Contributor

@nhachicha nhachicha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 👍
I think we should keep the original description for the packages underneath the new mention WDYT?

driver-core/src/main/com/mongodb/internal/connection/tlschannel/async/package-info.java

/**

* This package enables the usage of TLS Channel as an {@link

* java.nio.channels.AsynchronousByteChannel}.

Copy link

Contributor

@nhachicha nhachicha Oct 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't you want to keep the internal description though?

Copy link

Member Author

@rozza rozza Oct 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

driver-core/src/main/com/mongodb/internal/connection/tlschannel/package-info.java Outdated

* <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.

Copy link

Contributor

@nhachicha nhachicha Oct 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

@rozza


 Put back tlschannel javadoc

5beb799

@rozza rozza merged commit 0d34dfa into mongodb:main

Oct 9, 2025

3 of 5 checks passed

@rozza rozza deleted the JAVA-5975 branch

October 9, 2025 12:16

Labels

None yet

2 participants

@rozza @nhachicha

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Annotated all internal packages #1818

Annotated all internal packages #1818

Uh oh!

Conversation

@rozza rozza commented Oct 6, 2025

Uh oh!

rozza commented Oct 6, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

@nhachicha nhachicha left a comment

Choose a reason for hiding this comment

Uh oh!

@nhachicha nhachicha Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

@rozza rozza Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

@nhachicha nhachicha Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants