Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4739870
Votes 0
Synopsis Malformed @link tag when only newline between first and second arguments
Category doclet:tbd
Reported Against hopper-rc
Release Fixed 1.4.2(mantis)
State 10-Fix Delivered, bug
Priority: 4-Low
Related Bugs
Submit Date 30-AUG-2002
Description




FULL PRODUCT VERSION :
java version "1.4.1-beta"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.1-beta-b14)
Java HotSpot(TM) Client VM (build 1.4.1-beta-b14, mixed mode)

FULL OPERATING SYSTEM VERSION :
 customer  Windows 2000 [Version 5.00.2195]

A DESCRIPTION OF THE PROBLEM :
Javadoc does not recognize a @link tag when a carriage
return only separates the label from the member.
This happens only on html files (like "overview.html"
or "package.html") and not on java files.

STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
Here is an example of a text layout that leads to the error:

{@link java.awt.Color#getAlpha
getAlpha}

Please, note that the first line must not have any space on
its end.


EXPECTED VERSUS ACTUAL BEHAVIOR :
Expected result: Create the javadoc without any warning or
error.

ERROR MESSAGES/STACK TRACES THAT OCCUR :
[javadoc]   [javadoc] Generating C:\test\docs\api\index-all.html...
  [javadoc] C:\test\package.html: Tag @link: Malformed: java.awt.Color#getAlpha
  [javadoc] getAlpha
C:\test\package.html: warning - Tag @link:illegal character: "
  [javadoc] " in "java.awt.Color#getAlpha
  [javadoc] getAlpha"
  [javadoc] Building index for all classes...
  [javadoc] C:\test\package.html: warning - Tag @link:illegal character: "
  [javadoc] Generating C:\test\docs\api\overview-summary.html...
  [javadoc] C:\test\package.html: Tag @link: Malformed: java.awt.Color#getAlpha
  [javadoc] getAlpha
  [javadoc] " in "java.awt.Color#getAlpha
  [javadoc] getAlpha"
  [javadoc] C:\test\package.html: warning - Tag @link:illegal character: "
  [javadoc] " in "java.awt.Color#getAlpha
  [javadoc] getAlpha"
  [javadoc] C:\test\package.html: warning - Tag @link:illegal character: "
  [javadoc] " in "java.awt.Color#getAlpha
  [javadoc] getAlpha"
  [javadoc] C:\test\package.html: warning - Tag @link:illegal character: "
  [javadoc] " in "java.awt.Color#getAlpha
  [javadoc] getAlpha"
  [javadoc] C:\test\package.html: warning - Tag @link:illegal character: "
  [javadoc] " in "java.awt.Color#getAlpha
  [javadoc] getAlpha"
  [javadoc] C:\test\package.html: warning - Tag @link:illegal character: "
  [javadoc] " in "java.awt.Color#getAlpha
  [javadoc] getAlpha"
  [javadoc] Generating C:\test\docs\api\package-summary.html...
  [javadoc] C:\test\package.html: Tag @link: Malformed: java.awt.Color#getAlpha
  [javadoc] getAlpha
  [javadoc] C:\test\package.html: Tag @link: Malformed: java.awt.Color#getAlpha
  [javadoc] getAlpha
  [javadoc] Generating C:\test\docs\api\stylesheet.css...
  [javadoc] 7 warnings


REPRODUCIBILITY :
This bug can be reproduced always.

CUSTOMER WORKAROUND :
Add a space at the end of the first line
(Review ID: 163768) 
======================================================================
Work Around
N/A
Evaluation
I agree that a newline should be sufficient, and a space should not be required.
Lowering to P4 because it is not common to omit the space, and the workaround
of adding the space is easy.
  xxxxx@xxxxx   2002-09-03
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang