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

Support extracting javadoc HTML files generated by Javadoc 17 #1200

Merged
merged 4 commits into from
Oct 2, 2024

Conversation

GorgiAstro
Copy link
Contributor

Java 17 breaks the javadoc HTML file format again...

This proposal adds support for extracting HTML files generated by javadoc 17.

However, there is one bug that I didn't manage to fix after several hours of debugging: with javadoc 17 HTML files, there is a whitespace wrongly trimmed between public class and the name of the class. For instance, public class OpenIntToFieldHashMap is wrongly transformed to public classOpenIntToFieldHashMap.

I attached a ZIP file containing two HTML javadoc files from the same java code, one exported with java 11, one with java 17.
However, I didn't check the backwards compatibility with java 8 and 14 for instance, I only checked with Java 11 and 17.

example_html_javadoc_11_vs_17.zip

Copy link

codecov bot commented Jun 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.21%. Comparing base (09f325f) to head (f32eb49).
Report is 51 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1200   +/-   ##
=======================================
  Coverage   87.21%   87.21%           
=======================================
  Files         113      113           
  Lines       10277    10277           
  Branches     4088     4088           
=======================================
  Hits         8963     8963           
  Misses        718      718           
  Partials      596      596           
Flag Coverage Δ
87.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Thrameos
Copy link
Contributor

Big thanks. I keep hoping one day that javadoc would modernize with a css such that the pages are easier to parse. It has never happened.

@marscher
Copy link
Member

marscher commented Oct 2, 2024

I do not have the opportunity to test this and just trust you @GorgiAstro that you did it. Thanks for your contribution!

@marscher marscher merged commit 6b89751 into jpype-project:master Oct 2, 2024
26 checks passed
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