Fix JavaDoc on JDK 11. #702
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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
gjmwoods
approved these changes
May 18, 2020
gjmwoods
pushed a commit
to gjmwoods/neo4j-java-driver
that referenced
this pull request
May 27, 2020
- 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
gjmwoods
added a commit
that referenced
this pull request
May 27, 2020
- 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 Co-authored-by: Michael Simons <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
<code>-block, so this needed a fix.There are 2 solutions to the later:
Disabling modules in java-doc with
--no-module-directories, but that also applies to references to JDK classes, which would than be broken.(The one applied here): Check if
useModuleDirectoriesis set to something different than literalundefined: 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/1547989This is also applicable to 4.1.