Skip to content

Commit 70d7bee

Browse files
committed
Hide public/protected internal classes from the generated API documentation
HIBERNATE-52
1 parent 36812b1 commit 70d7bee

File tree

57 files changed

+191
-30
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+191
-30
lines changed

src/main/java/com/mongodb/hibernate/internal/FeatureNotSupportedException.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
import java.io.Serial;
2020
import java.sql.SQLFeatureNotSupportedException;
2121

22+
/** @hidden */
23+
@SuppressWarnings("MissingSummary")
2224
public final class FeatureNotSupportedException extends RuntimeException {
2325

2426
@Serial

src/main/java/com/mongodb/hibernate/internal/MongoAssertions.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@
1818

1919
import org.jspecify.annotations.Nullable;
2020

21-
/** Util class for various assertion purposes. */
21+
/**
22+
* Util class for various assertion purposes.
23+
*
24+
* @hidden
25+
*/
2226
public final class MongoAssertions {
2327

2428
private MongoAssertions() {}

src/main/java/com/mongodb/hibernate/internal/MongoChecks.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,11 @@
2020

2121
import org.jspecify.annotations.Nullable;
2222

23-
/** Util class for checking, for example, argument values. */
23+
/**
24+
* Util class for checking, for example, argument values.
25+
*
26+
* @hidden
27+
*/
2428
public final class MongoChecks {
2529
private MongoChecks() {}
2630

src/main/java/com/mongodb/hibernate/internal/MongoConstants.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
import org.bson.json.JsonMode;
2020
import org.bson.json.JsonWriterSettings;
2121

22+
/** @hidden */
23+
@SuppressWarnings("MissingSummary")
2224
public final class MongoConstants {
2325

2426
private MongoConstants() {}

src/main/java/com/mongodb/hibernate/internal/VisibleForTesting.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,17 @@
2626
* Denotes that the annotated program element is made more accessible than otherwise necessary for the purpose of
2727
* testing. The annotated program element must be used as if it had the {@linkplain #otherwise() intended} access
2828
* modifier for any purpose other than testing.
29+
*
30+
* @hidden
2931
*/
3032
@Documented
3133
@Retention(RetentionPolicy.SOURCE)
3234
@Target({ElementType.TYPE, ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.FIELD})
3335
public @interface VisibleForTesting {
3436
VisibleForTesting.AccessModifier otherwise();
3537

38+
/** @hidden */
39+
@SuppressWarnings("MissingSummary")
3640
enum AccessModifier {
3741
PRIVATE,
3842
PACKAGE,

src/main/java/com/mongodb/hibernate/internal/cfg/MongoConfiguration.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,6 @@
2626
* @param mongoClientSettings {@link MongoConfigurator#applyToMongoClientSettings(Consumer)}.
2727
* @param databaseName {@link MongoConfigurator#databaseName(String)}.
2828
* @see MongoConfigurationBuilder#build()
29+
* @hidden
2930
*/
3031
public record MongoConfiguration(MongoClientSettings mongoClientSettings, String databaseName) {}

src/main/java/com/mongodb/hibernate/internal/cfg/MongoConfigurationBuilder.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@
3333
import java.util.stream.Collectors;
3434
import org.jspecify.annotations.Nullable;
3535

36+
/** @hidden */
37+
@SuppressWarnings("MissingSummary")
3638
public final class MongoConfigurationBuilder implements MongoConfigurator {
3739
private final MongoClientSettings.Builder mongoClientSettingsBuilder;
3840
private @Nullable String databaseName;

src/main/java/com/mongodb/hibernate/internal/dialect/MongoAggregateSupport.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
import org.hibernate.mapping.AggregateColumn;
2626
import org.hibernate.mapping.Column;
2727

28+
/** @hidden */
29+
@SuppressWarnings("MissingSummary")
2830
public final class MongoAggregateSupport extends AggregateSupportImpl {
2931
public static final MongoAggregateSupport INSTANCE = new MongoAggregateSupport();
3032
public static final String UNSUPPORTED_MESSAGE_PREFIX =

src/main/java/com/mongodb/hibernate/internal/dialect/TestMongoDialect.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
import com.mongodb.hibernate.dialect.MongoDialect;
2020
import org.hibernate.engine.jdbc.dialect.spi.DialectResolutionInfo;
2121

22+
/** @hidden */
23+
@SuppressWarnings("MissingSummary")
2224
public abstract non-sealed class TestMongoDialect extends MongoDialect {
2325
protected TestMongoDialect(DialectResolutionInfo info) {
2426
super(info);

src/main/java/com/mongodb/hibernate/internal/dialect/function/array/MongoArrayConstructorFunction.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@
3434
* {@code array}, {@code array_list}</a>.
3535
*
3636
* <p>Thread-safe.
37+
*
38+
* @hidden
3739
*/
3840
public final class MongoArrayConstructorFunction extends ArrayConstructorFunction {
3941
static final Set<String> NAMES = Set.of("array", "array_list");

0 commit comments

Comments
 (0)