Community
Participate
Working Groups
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.
Note that there is a space after the reference Bug #69272 is related.
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" */
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.
Created attachment 73535 [details] [proposed patch] Fix + test case - all jdt.core tests ok
Created attachment 77113 [details] same patch synchronized with HEAD v808
(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).
Looks good +1
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.
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.
(In reply to comment #9) Looks good. +1
(In reply to comment #9) Looks definitely clearer :-) +1
Released for 3.4M3 in HEAD stream
Verified for 3.4M3 using I20071029-0010 build.