JDK-4739870 : Malformed @link tag when only newline between first and second arguments
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.4.1
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • OS: windows_2000
  • CPU: x86
  • Submitted: 2002-08-30
  • Updated: 2014-05-05
  • Resolved: 2002-10-25
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 Availabitlity Release.

To download the current JDK release, click here.
Other
1.4.2 mantisFixed
Description

Name: gm110360			Date: 08/30/2002


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 :
Microsoft 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) 
======================================================================

Comments
CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: mantis FIXED IN: mantis INTEGRATED IN: mantis mantis-b05
2004-06-14

PUBLIC COMMENTS The tool forgot to check for the windows carriage return when parsing inline tags. I have fixed this bug.
2004-06-10

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. ###@###.### 2002-09-03
2002-09-03