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

Upgrade JavaDocs to JDK 17 #5808

Closed
calcmogul opened this issue Oct 24, 2023 · 6 comments · Fixed by #6220
Closed

Upgrade JavaDocs to JDK 17 #5808

calcmogul opened this issue Oct 24, 2023 · 6 comments · Fixed by #6220
Labels
good first issue Good for newcomers. type: docs Related to documentation and information.

Comments

@calcmogul
Copy link
Member

calcmogul commented Oct 24, 2023

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.

@calcmogul calcmogul added the type: docs Related to documentation and information. label Oct 24, 2023
@sciencewhiz sciencewhiz added the good first issue Good for newcomers. label Oct 24, 2023
@rzblue
Copy link
Member

rzblue commented Oct 24, 2023

Specifically, every java symbol needs to be documented. This can (and should) be done over multiple PRs.

@m10653
Copy link
Contributor

m10653 commented Dec 7, 2023

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)
    }
    

@sciencewhiz
Copy link
Contributor

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.

@Gold856
Copy link
Contributor

Gold856 commented Dec 18, 2023

Since JDK 18, doclint can be supressed with the usual SuppressWarnings, which isn't helpful for us because we're on JDK 17. And updating to JDK 21 (the next LTS release) brings even more warnings. So maybe ignore the enum stuff for now?

@Gold856
Copy link
Contributor

Gold856 commented Dec 31, 2023

For posterity, #6119 removed about 3000 warnings.

@Gold856
Copy link
Contributor

Gold856 commented Jan 1, 2024

#6132 removes 84 warnings.

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. type: docs Related to documentation and information.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants