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

Javadoc issues #377

Open
dmlloyd opened this issue Nov 19, 2024 · 0 comments
Open

Javadoc issues #377

dmlloyd opened this issue Nov 19, 2024 · 0 comments

Comments

@dmlloyd
Copy link
Collaborator

dmlloyd commented Nov 19, 2024

There are a number of warnings when building javadocs which should be fixed. Once the problems are fixed, we can move to more strict doclint checking.

For example:

[INFO] --- maven-javadoc-plugin:3.10.0:javadoc (default-cli) @ smallrye-common-annotation ---
[INFO] No previous run data found, generating javadoc.
Warning:  Javadoc Warnings
Warning:  /home/runner/work/smallrye-common/smallrye-common/annotation/src/main/java/io/smallrye/common/annotation/Identifier.java:39: warning: no comment
Warning:  public static Literal of(String value) {
Warning:  ^
Warning:  /home/runner/work/smallrye-common/smallrye-common/annotation/src/main/java/module-info.java:1: warning: no comment
Warning:  module io.smallrye.common.annotation {
Warning:  ^
Warning:  /home/runner/work/smallrye-common/smallrye-common/annotation/src/main/java/io/smallrye/common/annotation/Identifier.java:37: warning: no comment
Warning:  private final String value;
Warning:  ^
Warning:  Note: Custom tags that could override future standard tags:  @implSpec, @apiNote, @implNote. To avoid potential overrides, use at least one period character (.) in custom tag names.
Warning:  Note: Custom tags that were not seen:  @implSpec, @apiNote, @implNote
Warning: [WARNING] 3 warnings
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

No branches or pull requests

1 participant