Replace unsupported <tt> tags in Javadoc comments #392
Conversation
This file contains 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
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.
When building Surefire with Java 17 (
OpenJDK 64-Bit Server VM Temurin-17+35) and Maven 3.6.3, the Javadoc generation process fails with the following error:The problem seems not to appear when building the project with Java 11 (
OpenJDK 64-Bit Server VM AdoptOpenJDK).As the
<tt>tag seems to be deprecated, it should probably be replaced with an HTML 5-compatible alternative like<code>. This PR introduces such a change.From the semantical point of view, not every introduced
<code>usage represents the actual code. In case it's not desirable to use it like this everywhere, we may consider replacing some of the occurrences with a different tag like<pre>.