United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4938109 Newlines are hard-coded as backslash-n all over standard doclet
JDK-4938109 : Newlines are hard-coded as backslash-n all over standard doclet

Details
Type:
Bug
Submit Date:
2003-10-15
Status:
Resolved
Updated Date:
2003-11-11
Project Name:
JDK
Resolved Date:
2003-11-11
Component:
docs
OS:
other,windows_2000
Sub-Component:
doclet
CPU:
generic
Priority:
P3
Resolution:
Fixed
Affected Versions:
5.0
Fixed Versions:
5.0 (b28)

Related Reports
Duplicate:

Sub Tasks

Description
There are "\n" characters hard coded all over the standard doclet code.  
We need to replace these characters with System.getProperty("line.seperator").

                                    

Comments
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
                                     
2003-10-15
PUBLIC COMMENTS

Fixed.  We now use the system specified default line separator.
###@###.### 2003-10-26
                                     
2003-10-26
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
tiger-beta

FIXED IN:
tiger-beta

INTEGRATED IN:
tiger-b28
tiger-beta


                                     
2004-06-14



Hardware and Software, Engineered to Work Together