Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the javadoc warnings under Java SE 17+ #719

Closed
starksm64 opened this issue Nov 30, 2023 · 0 comments · Fixed by #775
Closed

Fix the javadoc warnings under Java SE 17+ #719

starksm64 opened this issue Nov 30, 2023 · 0 comments · Fixed by #775
Milestone

Comments

@starksm64
Copy link
Contributor

Normally I have been building with Java SE 11, but when the PR for 4.1.0-M1 was failing under 17 and 21 I took a look a why, and ran across a ton of warnings, mostly about having no comment. It stopped at 100 so I assume there are many more than that.

[INFO] --- javadoc:3.6.0:jar (attach-javadocs) @ jakarta.enterprise.cdi-api ---
[INFO] No previous run data found, generating javadoc.
[WARNING] Javadoc Warnings
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/Annotated.java:27: warning: empty <p> tag
[WARNING] * <p>
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/Unmanaged.java:86: warning: no @param for <T>
[WARNING] public static class UnmanagedInstance<T> {
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/AfterTypeDiscovery.java:43: warning: no main description
[WARNING] * @return the list of enabled alternatives for the application, sorted by priority in ascending order. Alternatives enabled for a bean archive are not included.
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/AfterTypeDiscovery.java:49: warning: no main description
[WARNING] * @return the list of enabled interceptors for the application, sorted by priority in ascending order. Interceptors enabled for a bean archive are not included.
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/AfterTypeDiscovery.java:55: warning: no main description
[WARNING] * @return the list of enabled decorators for the application, sorted by priority in ascending order. Decorators enabled for a bean archive are not included.
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/AnnotatedType.java:69: warning: empty <p> tag
[WARNING] * <p>
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/Alternative.java:76: warning: no comment
[WARNING] public static final Literal INSTANCE = new Literal();
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/Alternative.java:74: warning: use of default constructor, which does not provide a comment
[WARNING] public final static class Literal extends AnnotationLiteral<Alternative> implements Alternative {
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/AmbiguousResolutionException.java:31: warning: no comment
[WARNING] public AmbiguousResolutionException() {
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/AmbiguousResolutionException.java:38: warning: no comment
[WARNING] public AmbiguousResolutionException(String message) {
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/AmbiguousResolutionException.java:34: warning: no comment
[WARNING] public AmbiguousResolutionException(String message, Throwable throwable) {
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/AmbiguousResolutionException.java:42: warning: no comment
[WARNING] public AmbiguousResolutionException(Throwable throwable) {
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedConstructorConfigurator.java:41: warning: no main description
[WARNING] * @return the original {@link AnnotatedConstructor}
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedConstructorConfigurator.java:93: warning: no main description
[WARNING] * @return an immutable list of {@link AnnotatedParameterConfigurator}s reflecting the
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedConstructorConfigurator.java:100: warning: no main description
[WARNING] * @param predicate Testing the original {@link AnnotatedParameter}
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedParameterConfigurator.java:38: warning: no main description
[WARNING] * @return the original {@link AnnotatedParameter}
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedFieldConfigurator.java:37: warning: no main description
[WARNING] * @return the original {@link AnnotatedField}
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedMethodConfigurator.java:40: warning: no main description
[WARNING] * @return the original {@link AnnotatedMethod}
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedMethodConfigurator.java:92: warning: no main description
[WARNING] * @return an immutable list of {@link AnnotatedParameterConfigurator}s reflecting the
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedMethodConfigurator.java:99: warning: no main description
[WARNING] * @param predicate Testing the original {@link AnnotatedParameter}
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedTypeConfigurator.java:60: warning: no main description
[WARNING] * @return the original {@link AnnotatedType}
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedTypeConfigurator.java:112: warning: no main description
[WARNING] * @return an immutable set of {@link AnnotatedMethodConfigurator}s reflecting the {@link AnnotatedType#getMethods()}
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedTypeConfigurator.java:117: warning: no main description
[WARNING] * @param predicate Testing the original {@link AnnotatedMethod}
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedTypeConfigurator.java:127: warning: no main description
[WARNING] * @return an immutable set of {@link AnnotatedFieldConfigurator}s reflecting the {@link AnnotatedType#getFields()}
[WARNING] ^
[WARNING] /home/starksm/Dev/Jakarta/rh-cdi/api/src/main/java/jakarta/enterprise/inject/spi/configurator/AnnotatedTypeConfigurator.java:132: warning: no main description
...
@starksm64 starksm64 added this to the CDI 4.1 milestone Nov 30, 2023
starksm64 added a commit to jakartaredhat/cdi that referenced this issue Feb 26, 2024
Fixes jakartaee#719

Signed-off-by: Scott M Stark <starksm64@gmail.com>
starksm64 added a commit that referenced this issue Feb 26, 2024
* Correct the javadoc warnings seen under JDK 17
Fixes #719

Signed-off-by: Scott M Stark <starksm64@gmail.com>

---------

Signed-off-by: Scott M Stark <starksm64@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant