JDK-8183583 : LSSerializer docs have invalid character
  • Type: Bug
  • Component: xml
  • Sub-Component: jaxp
  • Priority: P3
  • Status: Closed
  • Resolution: Fixed
  • Submitted: 2017-07-05
  • Updated: 2017-12-14
  • Resolved: 2017-07-05
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 10
10 b15Fixed
Related Reports
Relates :  
JDK-8183582 - Rationalize doclet -docencoding and -charset options
Description
The javadoc-generated file has an invalid character on line 236, in the sentence:

An example would be serializing
 the element &lt;LaCa\F1ada/&gt; with <code>encoding="us-ascii"</code>.

It shows up in the previous text as "\F1".

It arises from this text in the source file:
jaxp/src/java.xml/share/classes/org/w3c/dom/ls/LSSerializer.java

An example would be serializing
 * the element &lt;LaCa\u00f1ada/&gt; with <code>encoding="us-ascii"</code>.

javadoc should be better at handling characters like this (JDK-8183582) but it would also be better if the source used an entity here, instead of a direct Unicode character.  Unicode f1 is "Latin Small Letter N with Tilde" so the appropriate entity is &ntilde;