Bug 138028 - Javadoc: Tag inside URI-link (<a>) inside @see creates warning
Summary: Javadoc: Tag inside URI-link (<a>) inside @see creates warning
Status: RESOLVED DUPLICATE of bug 125518
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.2   Edit
Hardware: PC Windows XP
: P3 minor (vote)
Target Milestone: ---   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-04-21 14:46 EDT by Sarah Gerweck CLA
Modified: 2006-04-22 06:35 EDT (History)
0 users

See Also:

Attachments
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 Sarah Gerweck CLA 2006-04-21 14:46:47 EDT 
My javadoc comment is below. I'm offering a link to a web page and use an HTML tag inside the link. Eclipse flags this with `Javadoc: Malformed link reference`.

Although the Javadoc specifications are silent on whether you can use a tag inside a URI-link, its use of HTML syntax to delineate them strongly prejudices a reasonable interpretation toward permissiveness. Eclipse's Javadoc rendering engine handles this fine. I see no reason this should create a warning except misguided pedantry.

/**
 * System exit codes for application termination.
 * 
 * @see <a href="/man/sysexits.html">Manual page for <kbd>sysexits.h</kbd></a>
 */
Comment 1 Frederic Fusier CLA 2006-04-22 06:35:12 EDT 

*** This bug has been marked as a duplicate of 125518 ***