Skip to content

Fix JavaDoc on JDK 11. (#702) #713

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

Merged
merged 1 commit into from
May 27, 2020
Merged

Conversation

gjmwoods
Copy link
Contributor

  • JDK 11 JavaDoc is less lenient with HTML tags inside a -block, so this needed a fix.
  • We don’t use java-modules, so all modules are undefined. Therefor the search is broken.

There are 2 solutions to the later:

  1. Disabling modules in java-doc with --no-module-directories, but that also applies to references to JDK classes, which would than be broken.

  2. (The one applied here): Check if useModuleDirectories is set to something different than literal undefined: If so, leave it and let JavaDocs JavaScript magic handle things, otherwise set it to false, causing JavaDocs JavaScript todo nothing. For reference: https://stackoverflow.com/a/57284322/1547989

- JDK 11 JavaDoc is less lenient with HTML tags inside a <code>-block, so this needed a fix.
- We don’t use java-modules, so all modules are undefined. Therefor the search is broken.

There are 2 solutions to the later:
1. Disabling modules in java-doc with `--no-module-directories`, but that also applies to references to JDK classes, which would than be broken.

2. (The one applied here): Check if `useModuleDirectories` is set to something different than literal `undefined`: If so, leave it and let JavaDocs JavaScript magic handle things, otherwise set it to false, causing JavaDocs JavaScript todo nothing. For reference: https://stackoverflow.com/a/57284322/1547989
Copy link
Contributor

@michael-simons michael-simons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unasked for, but I guess I like the PR :D

@gjmwoods gjmwoods merged commit d7c1c1c into neo4j:4.1 May 27, 2020
@gjmwoods gjmwoods deleted the fix-java-doc-jdk11+ branch May 27, 2020 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants