Skip to content

Commit 76ecb29

Browse files
committed
Indicate that the annotations classes are for internal use only.
1 parent c261ee7 commit 76ecb29

3 files changed

Lines changed: 9 additions & 0 deletions

File tree

src/main/java/org/cthing/versionparser/internal/annotations/PackageNonnullByDefault.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,14 @@
2626

2727

2828
/**
29+
* For internal use only.
30+
* <p>
2931
* Declares that fields, method return types, method parameters, and type parameters within the annotated package
3032
* are not {@code null} by default. Items that can be null should be annotated with either
3133
* {@link javax.annotation.CheckForNull} or {@link javax.annotation.Nullable}. This annotation differs from
3234
* {@link javax.annotation.ParametersAreNonnullByDefault} which only marks method parameters as not {@code null}
3335
* by default.
36+
* </p>
3437
*/
3538
@Documented
3639
@Nonnull

src/main/java/org/cthing/versionparser/internal/annotations/UtilityClass.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,11 @@
2424

2525

2626
/**
27+
* For internal use only.
28+
* <p>
2729
* Annotation for the private constructor of a utility class. Can be used by IntelliJ to eliminate the constructor
2830
* from test coverage analysis.
31+
* </p>
2932
*/
3033
@Retention(RetentionPolicy.CLASS)
3134
@Target(ElementType.CONSTRUCTOR)

src/main/java/org/cthing/versionparser/internal/annotations/package-info.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
*/
1616

1717
/**
18+
* For internal use only.
19+
* <p>
1820
* Annotations for nullability.
21+
* </p>
1922
*/
2023
package org.cthing.versionparser.internal.annotations;

0 commit comments

Comments
 (0)