Skip to content

Commit 8745b38

Browse files
committed
Document that Assertions class is not part of the API
JAVA-4795
1 parent b60f872 commit 8745b38

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

driver-core/src/main/com/mongodb/assertions/Assertions.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@
3030
* for not using the {@code assert} statements is that they are not always enabled. We prefer having internal checks always done at the
3131
* cost of our code doing a relatively small amount of additional work in production.
3232
* The {@code assert...} methods return values to open possibilities of being used fluently.
33+
*
34+
* <p>This class is not part of the public API and may be removed or changed at any time</p>
3335
*/
3436
public final class Assertions {
3537
/**

gradle/javadoc.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ subprojects { project ->
4444
tasks.withType(Javadoc) {
4545
dependsOn tagletsProject.compileJava //We need taglets to be compiled
4646
exclude "**/com/mongodb/**/benchmark/**"
47+
exclude "**/com/mongodb/**/assertions/**"
4748
exclude "**/com/mongodb/**/internal/**"
4849
exclude "**/org/bson/**/internal/**"
4950
options {

0 commit comments

Comments
 (0)