Bug 48376 - Javadoc incorrect warning for wrapped links
Summary: Javadoc incorrect warning for wrapped links
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.0   Edit
Hardware: PC Windows XP
: P3 minor (vote)
Target Milestone: 3.0 M7   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2003-12-09 18:16 EST by Gary Gregory CLA
Modified: 2004-02-11 07:34 EST (History)
0 users

See Also:

Attachments
screenshot (6.07 KB, image/png)
2004-01-09 13:42 EST, Gary Gregory CLA 		no flags Details
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Gary Gregory CLA 2003-12-09 18:16:22 EST 
The following javadoc fragment:

<snip>
	 * @see <a
href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/tsqlref/ts_de-dz_8co5.asp">MS
T-SQL DIFFERENCE</a>
<snip>

Gets formatted into:

<snip>
	 * @see <a
href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/tsqlref/ts_de-dz_8co5.asp">
	 *          MS T-SQL DIFFERENCE</a>
<snip>

Note that the one liner @see was broken up into two lines, which is fine with me.

This causes an incorrect warning:

Severity	Description	Resource	In Folder	Location	Creation Time
	Javadoc: Invalid URL link format	Soundex.java	Apache Jakarta
Commons/codec/src/java/org/apache/commons/codec/language	line 87	December 9,
2003 3:10:00 PM
Comment 1 Dani Megert CLA 2004-01-08 05:49:30 EST 
>Note that the one liner @see was broken up into two lines, which is fine with me.
The warning is correct since in the resulting (generated) Javadoc the link will
simply not work.

Adapted the summary.
Comment 2 Gary Gregory CLA 2004-01-08 14:30:25 EST 
I beg to differ, the Javadoc generated link DOES work (Tested with Sun 1.4.2_03).
Comment 3 Dani Megert CLA 2004-01-09 03:07:34 EST 
I did not test it but expected that the doclet isn't that smart.

Is the link correctly shown i.e. as <startLink>T-SQL DIFFERENCE<endLink>?
What about the * in front of T-SQL DIFFERENCE?
Comment 4 Gary Gregory CLA 2004-01-09 13:42:48 EST 
Created attachment 7394 [details]
screenshot
Comment 5 Gary Gregory CLA 2004-01-09 13:43:50 EST 
I promise I am not making this up! 

;-)

See attached for proper display of link "MS T-SQL DIFFERENCE".
Comment 6 Dani Megert CLA 2004-01-12 02:51:09 EST 
Reverting summary and moving to J Core: they generate the warning.
Comment 7 Frederic Fusier CLA 2004-01-19 06:25:37 EST 
If the link works, I agree to remove the warning...
Comment 8 Frederic Fusier CLA 2004-01-19 13:19:00 EST 
Fixed.

parseHref() method has been modified to allow new lines in href tag text.

Test cases added in jdt.core.tests.compiler.regression.JavadocTestMixed
Comment 9 David Audel CLA 2004-02-11 07:34:52 EST 
Verified for 3.0M7