JDK-4938109 : Newlines are hard-coded as backslash-n all over standard doclet
Type:Bug
Component:tools
Sub-Component:javadoc(tool)
Affected Version:5.0
Priority:P3
Status:Resolved
Resolution:Fixed
OS:other,windows_2000
CPU:generic
Submitted:2003-10-15
Updated:2014-05-05
Resolved:2003-11-11
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.
There are "\n" characters hard coded all over the standard doclet code.
We need to replace these characters with System.getProperty("line.seperator").
Comments
CONVERTED DATA
BugTraq+ Release Management Values
COMMIT TO FIX:
tiger-beta
FIXED IN:
tiger-beta
INTEGRATED IN:
tiger-b28
tiger-beta
14-06-2004
PUBLIC COMMENTS
Fixed. We now use the system specified default line separator.
###@###.### 2003-10-26
26-10-2003
EVALUATION
Here's the reason we hard-coded these as \n (tell me if this makes sense).
The docs we release are generated on Solaris. However, most of our users use Windows (about
90%).
These are the line separators:
Unix - line feed
Windows - Carriage return + line feed
Macintosh - carriage return
I don't know what \n is -- is it line feed or carriage return or both?
If you choose View > Source on Internet Explorer of our Solaris-generated
javadocs the HTML source currently appears exactly as you would expect it,
with each HTML line of text on a separate line.
However, it used to be that View > Source would display the HTML as a single
paragraph with the newlines ignored, which made it extremely difficult
for people (particularly me) to diagnose the HTML. This was because the
"View Source" mode of IE does not interpret a line feed as a line separator,
I suppose. I asked Atul to fix the pages so they could be easily viewed in
View Source on Windows. (I cannot find any bug report on this.)
Anyway, I think it's quite important for people on all platforms to be able
to easily diagnose the HTML. I don't know if View Source has been made
any smarter, but please check that out before making the change below.
Are there other considerations that should overrule this?
###@###.### 2003-10-15