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 JavaDoc Warnings #979

Closed
mkarg opened this issue Jun 19, 2021 · 9 comments
Closed

Fix JavaDoc Warnings #979

mkarg opened this issue Jun 19, 2021 · 9 comments
Assignees
Labels
good first issue Good for newcomers javadoc
Milestone

Comments

@mkarg
Copy link
Contributor

mkarg commented Jun 19, 2021

There are several JavaDoc warnings in examples and jaxrs-api sources.

This is a good newcomer's issue.

@mkarg mkarg added good first issue Good for newcomers javadoc labels Jun 19, 2021
@mkarg mkarg added this to the 3.1 milestone Jun 19, 2021
@mkarg mkarg self-assigned this Jun 21, 2021
@andygibson
Copy link
Contributor

Submitted PRs #984 , #985 and #986

@chkal
Copy link
Contributor

chkal commented Jun 22, 2021

@andygibson Thanks a lot! Looks great!

@spericas spericas added this to To do in Jakarta REST 3.1 Jul 7, 2021
@mkarg
Copy link
Contributor Author

mkarg commented Sep 30, 2021

There are new JavaDoc warnings. Maybe one of our new contributors like to fix it for 3.1? :-)

5 warnings
[WARNING] Javadoc Warnings
[WARNING] /workspace/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:137: warning: @param "T" has already been specified
[WARNING] * @param <T> the entity type
[WARNING] ^
[WARNING] /workspace/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:176: warning: @param "T" has already been specified
[WARNING] * @param <T> the entity type
[WARNING] ^
[WARNING] /workspace/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:322: warning: @param "T" has already been specified
[WARNING] * @param <T>     the entity type
[WARNING] ^
[WARNING] /workspace/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:349: warning: @return has already been specified
[WARNING] * @return the updated builder.
[WARNING] ^
[WARNING] /workspace/jaxrs-api/jaxrs-api/src/main/java/jakarta/ws/rs/core/EntityPart.java:374: warning: @param "T" has already been specified
[WARNING] * @param <T> the entity type
[WARNING] ^

@mkarg mkarg reopened this Sep 30, 2021
@mkarg
Copy link
Contributor Author

mkarg commented Sep 30, 2021

@jelemux Like to fix this one? :-)

@jelemux
Copy link
Contributor

jelemux commented Oct 1, 2021

@mkarg Yes, I do. I'll see if I can find some time for it over the weekend.

@mkarg
Copy link
Contributor Author

mkarg commented Oct 1, 2021

@jelemux Is preparing a PR for this. Thank you, Jeremias! :-)

@jelemux
Copy link
Contributor

jelemux commented Oct 3, 2021

Submitted PR #1028


Also, what is to be done about the issue I mentioned?

What maybe should be addressed as well are the JavaDoc Errors in jaxrs-tck.
There are lots of errors because the code just got ported and focus was on the migration.
Maybe we don't need to generate JavaDoc for this at all though and it can be excluded? WDYT?
Should this be discussed in a seperate PR / issue?

mkarg added a commit to mkarg/rest that referenced this issue Dec 23, 2021
mkarg added a commit to mkarg/rest that referenced this issue Dec 23, 2021
mkarg added a commit to mkarg/rest that referenced this issue Dec 23, 2021
@mkarg
Copy link
Contributor Author

mkarg commented Dec 23, 2021

@spericas @andymc12 @chkal @jansupol There are no more warnings in the API itself, but there are 100+ warnings in the Examples and TCK. To not further delay publication of 3.1, I'd like to propose that I do split this issue, i.e. I do close this one and reopen two separate issues for Examples and TCK which we resolve in 4.0. WDYT?

@mkarg mkarg moved this from To do to In progress in Jakarta REST 3.1 Dec 23, 2021
mkarg added a commit that referenced this issue Jan 9, 2022
@spericas
Copy link
Contributor

@mkarg As you suggested, closing this one. Let's reopen one for 4.0.

@spericas spericas moved this from In progress to Done in Jakarta REST 3.1 Apr 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers javadoc
Projects
Release.next
Awaiting triage
Development

No branches or pull requests

5 participants