-
Notifications
You must be signed in to change notification settings - Fork 613
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
Upgrade JavaDocs to JDK 17 #5808
Comments
Specifically, every java symbol needs to be documented. This can (and should) be done over multiple PRs. |
I noticed that many of these Check Style warnings are due to Enums missing javadoc comments. It does not seem like anywhere in wpilib the values of the enums themselves have comments and they can be a bit clunky. Is adding javadoc comments to the values of the enums desired or would modifying the style rules/annotations to ignore this style/docs violation preferred. Example of these comments public enum CalibrationTime {
/** Calibration time of 32 milliseconds */
_32ms(0),
/** Calibration time of 64 milliseconds */
_64ms(1)
}
|
The warnings are from the javadoc doclint. I have not figured out how to suppress just the missing enuns warning, without suppressing all missing documentation warnings (which we don't want to suppress all) if this was from checkstyle, they could be suppressed. If you can figure out how to suppress only the missing enum documentation, that would be preferable. |
Since JDK 18, doclint can be supressed with the usual |
For posterity, #6119 removed about 3000 warnings. |
#6132 removes 84 warnings. |
There's a lot of warnings from
./gradlew docs:generateJavaDocs -PdocWarningsAsErrors
to fix, which are usually from missing docs.You can usually find the docs for JNI a layer down, like in the HAL or whatever C++ the JNI wraps.
The text was updated successfully, but these errors were encountered: