Skip to content

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

Merged
enebo merged 1 commit intojruby:masterfrom
rcrews:GH-6607
Apr 23, 2023
Merged

GH-6607 Clean up javadoc for stricter Java 11#7765
enebo merged 1 commit intojruby:masterfrom
rcrews:GH-6607

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 enebo and headius April 22, 2023 03:57
@enebo enebo merged commit 17ceae2 into jruby:master Apr 23, 2023
@enebo
Copy link
Member

enebo commented Apr 23, 2023

@rcrews Fantastic!

@rcrews rcrews deleted the GH-6607 branch April 24, 2023 19:50
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.

3 participants