-
Bug
-
Resolution: Fixed
-
P4
-
8
-
x86
-
windows_8
A DESCRIPTION OF THE REQUEST :
The -Xdoclint feature added to Java 8 reports unrecognized HTML entities as errors. This includes all entities which were added to HTML 5 but not present in an earlier version. Some documentation includes these tags due to the lack of an HTML 4 alternative, and in modern browsers the result renders as expected. When moving to Java 8, these projects are forced to do one of the following:
1. Disable an otherwise useful feature provided -Xdoclint
2. Remove useful information or behavior from the documentation for their code
JUSTIFICATION :
The documentation produced for ANTLR 4 *requires* the use of the "embed" tag for proper behavior of the hyperlinked SVG diagrams, shown on the following page.
http://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATNState.html
EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
Until the javadoc tool fully supports HTML 5, the use of HTML entities which are new to HTML 5 should produce a warning when compiled with -Xdoclint.
ACTUAL -
The use of HTML entities which are new to HTML 5 produce an *error* when compiled with -Xdoclint.
---------- BEGIN SOURCE ----------
Include the following line in a javadoc, and compile with -Xdoclint.
https://github.com/antlr/antlr4/blob/a9628b0ff05e593ebfe9ba05da91ebb5ace79d06/runtime/Java/src/org/antlr/v4/runtime/atn/ATNState.java#L67
---------- END SOURCE ----------
CUSTOMER SUBMITTED WORKAROUND :
Disable -Xdoclint when compiling this code with Java 8.
The -Xdoclint feature added to Java 8 reports unrecognized HTML entities as errors. This includes all entities which were added to HTML 5 but not present in an earlier version. Some documentation includes these tags due to the lack of an HTML 4 alternative, and in modern browsers the result renders as expected. When moving to Java 8, these projects are forced to do one of the following:
1. Disable an otherwise useful feature provided -Xdoclint
2. Remove useful information or behavior from the documentation for their code
JUSTIFICATION :
The documentation produced for ANTLR 4 *requires* the use of the "embed" tag for proper behavior of the hyperlinked SVG diagrams, shown on the following page.
http://www.antlr.org/api/Java/org/antlr/v4/runtime/atn/ATNState.html
EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
Until the javadoc tool fully supports HTML 5, the use of HTML entities which are new to HTML 5 should produce a warning when compiled with -Xdoclint.
ACTUAL -
The use of HTML entities which are new to HTML 5 produce an *error* when compiled with -Xdoclint.
---------- BEGIN SOURCE ----------
Include the following line in a javadoc, and compile with -Xdoclint.
https://github.com/antlr/antlr4/blob/a9628b0ff05e593ebfe9ba05da91ebb5ace79d06/runtime/Java/src/org/antlr/v4/runtime/atn/ATNState.java#L67
---------- END SOURCE ----------
CUSTOMER SUBMITTED WORKAROUND :
Disable -Xdoclint when compiling this code with Java 8.