Bug 207765

Summary:

[javadoc] Javadoc warning on @see reference could be improved

Product:

[Eclipse Project] JDT

Reporter:

David Audel <david_audel>

Component:

Core

Assignee:

Frederic Fusier <frederic_fusier>

Status:

VERIFIED FIXED

QA Contact:

Severity:

trivial

Priority:

Version:

3.3

Target Milestone:

3.5 M2

Hardware:

OS:

Windows XP

Whiteboard:

Attachments:

Description	Flags
[proposed patch + test case] on top v_872	none
Updated patch on top of v_912	none

Description David Audel

2007-10-29 08:32:04 EDT

Found this problem during verification of bug 168849.

When the javadoc is:
/**
 * @see http://en.wikipedia.org/wiki/ISO_8601
 */
The warning is:
Javadoc: Invalid URL reference. Double quote the reference or use the href syntax

When the javadoc is:
/**
 * @see http://en.wikipedia.org/wiki/ISO_8601"
 */
The warning contains the 'ending' quote and is:
Javadoc: Invalid URL reference. Double quote the reference or use the href syntax

When the javadoc is:
/**
 * @see "http://en.wikipedia.org/wiki/ISO_8601
 */
The warning contains the 'opening' quote and is:
Javadoc: Invalid reference



In the last case it would be better if the warning is:
Javadoc: Invalid URL reference. Double quote the reference or use the href

Comment 1 Eric Jodet

2008-06-04 10:14:44 EDT

Created attachment 103553 [details]
[proposed patch + test case] on top v_872

Comment 2 Frederic Fusier

2008-09-12 11:52:15 EDT

Created attachment 112436 [details]
Updated patch on top of v_912

Previous proposed patch wrongly changed the warning for following syntax:
/**
 * @see "Invalid
 */

The updated one proposes the warning "Javadoc: Invalid URL reference..." only when the unterminated string starts with http://
Note that not only 'http' but any name is accepted as we can also have 'https', 'net', 'ftp', etc.

Comment 3 Frederic Fusier

2008-09-12 11:52:55 EDT

Released for 3.5M2

Comment 4 David Audel

2008-09-15 07:20:15 EDT

Verified for 3.5M2 using I20080914-2000