Bug 168849 - [javadoc] Javadoc warning on @see reference in class level docs.
Summary: [javadoc] Javadoc warning on @see reference in class level docs.
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.2.1   Edit
Hardware: PC Windows XP
: P3 minor (vote)
Target Milestone: 3.4 M3   Edit
Assignee: Eric Jodet CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-12-21 10:08 EST by skeens CLA
Modified: 2007-10-29 08:32 EDT (History)
4 users (show)

See Also:


Attachments
[proposed patch] (14.79 KB, patch)
2007-07-11 10:00 EDT, Eric Jodet CLA
no flags Details | Diff
same patch synchronized with HEAD v808 (14.80 KB, patch)
2007-08-28 06:59 EDT, Eric Jodet CLA
no flags Details | Diff
[proposed patch + test case] on top v815 - all jdt.core tests OK (15.76 KB, patch)
2007-10-01 12:08 EDT, Eric Jodet CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description skeens CLA 2006-12-21 10:08:07 EST
Have this class level java documentation

/**
 * @see http://en.wikipedia.org/wiki/ISO_8601 
 */

Get a "Javadoc: Malformed reference (missing end space separator)" warning on the reference.
Comment 1 skeens CLA 2006-12-21 10:13:17 EST
Note that there is a space after the reference
Bug #69272 is related.
Comment 2 Frederic Fusier CLA 2006-12-22 03:56:45 EST
This is indeed an invalid reference. Javadoc tool reports following warning messages on this syntax:
warning - Tag @see:illegal character: "58" in "http://en.wikipedia.org/wiki/ISO_8601"
warning - Tag @see:illegal character: "47" in "http://en.wikipedia.org/wiki/ISO_8601"
warning - Tag @see:illegal character: "47" in "http://en.wikipedia.org/wiki/ISO_8601"
warning - Tag @see:illegal character: "47" in "http://en.wikipedia.org/wiki/ISO_8601"
warning - Tag @see:illegal character: "47" in "http://en.wikipedia.org/wiki/ISO_8601"

The problem is more than error message is not appropriate in this case. Should be more something like: "Invalid characters encountered in reference".

Note that bug 69272 is not related and the trailing space does not matter.
In fact you forgot the quotes around the reference, the correct syntax is:
/**
 * @see "http://en.wikipedia.org/wiki/ISO_8601"
 */
Comment 3 skeens CLA 2007-01-08 13:39:35 EST
I have put the quotes around my reference and that fixes the problem.  The message you suggest is good.  Perhaps it can be augmented with a quick fix - surrounding the reference with quotes.
Comment 4 Eric Jodet CLA 2007-07-11 10:00:26 EDT
Created attachment 73535 [details]
[proposed patch]

Fix + test case - all jdt.core tests ok
Comment 5 Eric Jodet CLA 2007-08-28 06:59:50 EDT
Created attachment 77113 [details]
same patch synchronized with HEAD v808
Comment 6 Frederic Fusier CLA 2007-09-28 09:23:04 EDT
(In reply to comment #5)
> Created an attachment (id=77113) [details]
> same patch synchronized with HEAD v808
> 
Patch looks good: +1

Just be careful while releasing as you'll get a conflict with bug 73352 patch (same IProblem ID).
Comment 7 Kent Johnson CLA 2007-09-28 10:00:52 EDT
Looks good +1
Comment 8 Jerome Lanneluc CLA 2007-10-01 04:59:42 EDT
Maybe it is just because I'm new to this, but I find this code very confusing. It is using concepts that are too close:
1. what's the difference between invalid and malformed ?
2. what's the difference between SeeHrlReference and SeeHref ?
3. javadocMalformedSeeUrlReference() is using JavadocInvalidSeeHref, why is that so ?
You should try to find better names to describes this concepts. If you cannot come up with better names, them this needs to be commented extensively with examples.
Comment 9 Eric Jodet CLA 2007-10-01 12:08:26 EDT
Created attachment 79491 [details]
[proposed patch + test case] on top v815 - all jdt.core tests OK

as per Jerome remarks in comment#8.
- the new method in the ProblemReporter renamed: javadocInvalidSeeHref, to address IProblem.JavadocInvalidSeeHref problems,
- modified the method in the ProblemReporter: javadocInvalidSeeUrlReference to address IProblem.JavadocInvalidSeeUrlReference
- added comments to help better understand the difference between javadocInvalidSeeHref and javadocInvalidSeeUrlReference, which are supposed to address different kind of issues.
- these are "cosmetic" changes that do not change the way this bug was fixed.
May reviewers of this bug please review this new patch. Thanks.
Comment 10 Jerome Lanneluc CLA 2007-10-03 10:29:07 EDT
(In reply to comment #9)
Looks good. +1
Comment 11 Frederic Fusier CLA 2007-10-03 10:37:02 EDT
(In reply to comment #9)
Looks definitely clearer :-) +1
Comment 12 Eric Jodet CLA 2007-10-04 09:08:50 EDT
Released for 3.4M3 in HEAD stream
Comment 13 David Audel CLA 2007-10-29 08:32:15 EDT
Verified for 3.4M3 using I20071029-0010 build.