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.

Sign up for GitHub

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

Jump to bottom

Reduce JavaDoc warnings for jwpl-api to zero. #287

Closed
mawiesne opened this issue Dec 1, 2023 · 0 comments · Fixed by #288
Closed

Reduce JavaDoc warnings for jwpl-api to zero. #287

mawiesne opened this issue Dec 1, 2023 · 0 comments · Fixed by #288
Assignees
@mawiesne
Milestone
2.0.1

Comments

@mawiesne
Copy link
Contributor

mawiesne commented Dec 1, 2023

Describe the refactoring action
During generation of the javadoc artifact several hundreds of warnings are logged to the maven console output.
This should be resolved by applying fixes for missing (a) javadoc for classes, (b) parameters, (c) return values, and (d) exceptions

Expected benefit
No more warnings during javadoc plugin runs.
Improved quality of the javadoc generated as html pages for JWPL devs and the (user) community.
@mawiesne mawiesne self-assigned this Dec 1, 2023
@mawiesne mawiesne added this to the 2.0.1 milestone Dec 1, 2023
mawiesne added a commit that referenced this issue Dec 1, 2023
@mawiesne
#287 - Reduce JavaDoc warnings for jwpl-api to zero
eaa0516 
- applies fixes to many api classes and interfaces to clear out hundreds of warnings
- removes (super) dead and worthless code from several very long classes (along the path)

Fixes #287
@mawiesne mawiesne mentioned this issue Dec 1, 2023
Merged
2 tasks
mawiesne added a commit that referenced this issue Dec 1, 2023
@mawiesne
#287 - Reduce JavaDoc warnings for jwpl-api to zero (#288)
3d50052 
- applies fixes to many api classes and interfaces to clear out hundreds of warnings
- removes (super) dead and worthless code from several very long classes (along the path)

Fixes #287
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mawiesne mawiesne

Labels
None yet
Projects
None yet
Milestone
2.0.1
Development

Successfully merging a pull request may close this issue.

#287 - Reduce JavaDoc warnings for jwpl-api to zero dkpro/dkpro-jwpl
1 participant
@mawiesne