Replace unsupported tags in Javadoc comments by mikemybytes · Pull Request #392 · apache/maven-surefire (original) (raw)

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:

[ERROR] /home/mike/Workspace/maven-surefire/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReportEntry.java:[79,89] error: tag not supported in HTML5: tt

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>.