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

GH-6607 Clean up javadoc for stricter Java 11 #7765

Merged
merged 1 commit into from Apr 23, 2023
Merged

Conversation

rcrews
Copy link
Contributor

@rcrews rcrews commented Apr 22, 2023

Resolved "errors" reported by JDK 20; many "warnings" remain

  • Add {@literal @} where needed
  • Change tt elements to code elements
  • Convert @MRI to

    MRI: ...

  • Convert @note to

    Note: ...

  • Convert self-closing XML tags to HTML
  • Encode <, >, & for HTML
  • Fix @see/@link syntax
  • Fix @see/@link values
  • Fix HTML element order in several places
  • Fix Javadoc tag order in a couple places
  • Fix several unordered lists
  • Fix spelling of problematic @param's
  • Fix that HTML table
  • Verify all changes were within Javadoc comments only

Resolved "errors" reported by JDK 20; many "warnings" remain

- Add {@literal @} where needed
- Change tt elements to code elements
- Convert @MRI to MRI:... wrapped in a p element
- Convert @note to Note:... wrapped in a p element
- Convert self-closing XML tags to HTML
- Encode <, >, & for HTML
- Fix @see/@link syntax
- Fix @see/@link values
- Fix HTML element order in several places
- Fix Javadoc tag order in a couple places
- Fix several unordered lists
- Fix spelling of problematic @param's
- Fix that HTML table
- Verify all changes were within Javadoc comments only
@headius headius added this to the JRuby 9.4.3.0 milestone Apr 22, 2023
@headius headius requested review from headius and enebo April 22, 2023 03:57
@enebo enebo merged commit 17ceae2 into jruby:master Apr 23, 2023
45 of 49 checks passed
@enebo
Copy link
Member

enebo commented Apr 23, 2023

@rcrews Fantastic!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants