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

Fix all javadoc warnings #6

Open
devinrsmith opened this issue Jan 21, 2022 · 1 comment
Open

Fix all javadoc warnings #6

devinrsmith opened this issue Jan 21, 2022 · 1 comment
Assignees
@kosak
Labels
enhancement New feature or request
Milestone
backlog

Comments

@devinrsmith
Copy link
Member

#5 adds javadoc as part of the build process. That PR fixes all the hard javadoc errors, but there are still a lot (~100) javadoc warnings; run ./gradlew javadoc to see them.

We should fix all javadoc warnings; if we want to be pedantic, we can also add logic to fail on javadoc warnings.
@devinrsmith devinrsmith added the enhancement New feature or request label Jan 21, 2022
@devinrsmith devinrsmith added this to the 0.0.1 milestone Jan 21, 2022
@devinrsmith
Copy link
Member Author

Note: debian/ubuntu disable javadoc warnings by default (even though they aren't fatal...).

See https://sources.debian.org/patches/openjdk-11/11.0.13+8-1/disable-doclint-by-default.diff/

@devinrsmith devinrsmith modified the milestones: 0.0.1, backlog Mar 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kosak kosak

Labels
enhancement New feature or request
Projects
None yet
Milestone
backlog
Development

No branches or pull requests
2 participants
@kosak @devinrsmith