Bug 125518 - [javadoc] Embedding html in a link placed in a @see JavaDoc tag causes a warning
Summary: [javadoc] Embedding html in a link placed in a @see JavaDoc tag causes a warning
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.1.1   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.4 M3   Edit
Assignee: Eric Jodet CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 138028 (view as bug list)
Depends on:
Blocks:
 
Reported: 2006-01-27 12:58 EST by Mathew Reno CLA
Modified: 2007-10-29 08:34 EDT (History)
6 users (show)

See Also:

Attachments
[proposed patch] (9.74 KB, patch)
2007-07-11 09:45 EDT, Eric Jodet CLA 		no flags Details | Diff
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 Mathew Reno CLA 2006-01-27 12:58:54 EST 
Problem exists with the released 3.1.2 and 3.1.1.
Within JavaDoc, place a @see tag and a link within that tag with embedded html, such as:
* @see <a href="www.xyzzy.com/rfc123.html"><i>RFC&nbsp;123</i></a>

From the "<i>" to the end of the line will be flagged as a warning with the comment: "Javadoc: Malformed link reference". The warning can be avoided by removing the "<i>" and "</i>" tags.

Sun uses this convention, which I wanted to emulate, in their code. For example, see the JavaDoc for java.net.URI.
Comment 1 Frederic Fusier CLA 2006-04-12 16:08:15 EDT 
Need to fix this globally and not only embedded html tag. I mean that some URL are warned by javadoc.exe although they aren't in eclipse and vice-versa.
As this would have a significant impact on existing Javadoc tests and this is not a high priority bug, I defer it to next release.
Comment 2 Frederic Fusier CLA 2006-04-22 06:35:12 EDT 
*** Bug 138028 has been marked as a duplicate of this bug. ***
Comment 3 Frederic Fusier CLA 2007-06-13 09:38:24 EDT 
I think we should fix this one for 3.4 as we do not behaves as the Javadoc tool...
Comment 4 Eric Jodet CLA 2007-07-11 09:45:26 EDT 
Created attachment 73533 [details]
[proposed patch]

Fix + test cases (passes all jdt.core tests)
Comment 5 Jerome Lanneluc CLA 2007-08-31 04:33:48 EDT 
Patch looks good to me, so +1 for this patch.
Comment 6 Eric Jodet CLA 2007-08-31 04:38:41 EDT 
(In reply to comment #4)
Frederic: may you please review proposed patch - thanks
Comment 7 Frederic Fusier CLA 2007-08-31 06:48:46 EDT 
(In reply to comment #6)
> Frederic: may you please review proposed patch - thanks
> 
OK for me
Comment 8 Eric Jodet CLA 2007-10-04 09:11:20 EDT 
Released for 3.4M3 in HEAD stream
Comment 9 David Audel CLA 2007-10-29 08:34:40 EDT 
Verified for 3.4M3 using I20071029-0010 build.