Bugzilla – Full Text Bug Listing
| Summary: | [javadoc] @see package reference should raise a warning except for the package declaration | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Product: | [Eclipse Project] JDT | Reporter: | Frederic Fusier <frederic_fusier> | ||||||
| Component: | Core | Assignee: | Frederic Fusier <frederic_fusier> | ||||||
| Status: | VERIFIED FIXED | QA Contact: | |||||||
| Severity: | normal | ||||||||
| Priority: | P3 | CC: | bugs, david_audel, philippe_mulet | ||||||
| Version: | 3.0 | ||||||||
| Target Milestone: | 3.5 M2 | ||||||||
| Hardware: | PC | ||||||||
| OS: | Windows XP | ||||||||
| Whiteboard: | |||||||||
| Attachments: |
|
||||||||
Created attachment 103720 [details]
[proposed patch + test case] on top v_872
Note that Fix for bug 50695 intended to disable validation for packages references, so that no warning should be raised. With the fix for this bug comes a new behavior, where only references to package declaration will be accepted. Hence, test cases corresponding to bug 50695 had to be modified in the attached patch. Created attachment 103733 [details]
[proposed patch + test cases] on top v_872
better patch (thanks frederic) and new test case
Released for 3.5M2 Verified for 3.5M2 using I20080914-2000 Please see bug 281609. Technically, this was an invalid effort and needs to be reverted. See bug 281609 comment #6 for specifics. |
Consider the following test case: package pack; public class Test { /** * @see java * @see java.lang */ public void foo() {} } Generate this test case with Javadoc tool, produces 2 warnings: Generating D:\workspace\doc\pack\Test.html... D:\workspace\src\pack\Test.java:8: warning - Tag @see: reference not found: java D:\workspace\src\pack\Test.java:8: warning - Tag @see: reference not found: java.lang JDT compiler does not raise any warning, even while processing Javadoc comments and reporting invalid references in tag. Open this bug on version 3.0 as this behavior difference with Javadoc tool is the direct consequence of fix for bug 50695 which has been released in 3.0M7! Note that bug 50695 was fixed upon Javadoc tool 1.4 "specification": http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#@see (see table Typical forms for @see package.class#member) But it seems that the last syntax of this table "@see package" is only valid for the package declaration. All other package references produce a warning during the Javadoc tool generation. So, following syntax should still be accepted: package pack; public class Test { /** * @see pack */ public void foo() {} }