Bug 149013 - [javadoc] In latest 3.3 build, there is a javadoc error in org.eclipse.core.resources
Summary: [javadoc] In latest 3.3 build, there is a javadoc error in org.eclipse.core.r...
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.2   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.3 M1   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-06-28 10:54 EDT by Michael Valenta CLA
Modified: 2006-08-04 12:52 EDT (History)
1 user (show)

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 Michael Valenta CLA 2006-06-28 10:54:24 EDT 
If you load the org.eclipse.core.resources from HEAD using I20060627-1200, there is a javadoc error in ProjectContentTypes.java. The class has an import:

org.eclipse.core.runtime.content.IContentTypeManager.ISelectionPolicy

and uses "@see ISelectionPolicy" in the javadoc. This is being reported as an error. The only way to fix the error is to use the fully qualified type name.
Comment 1 Michael Valenta CLA 2006-06-28 10:55:20 EDT 
I was told this is your area, Frederic.
Comment 2 Frederic Fusier CLA 2006-06-28 11:25:57 EDT 
Due to bug 96237 fix, I'm currently polishing it...
What is your compiler javadoc settings?
Comment 3 Michael Valenta CLA 2006-06-28 11:27:48 EDT 
They are the defaults for my workspace but the org.eclipse.core.reaources plugin may have custom settings.
Comment 4 Frederic Fusier CLA 2006-06-28 11:31:12 EDT 
Note that generate documentation with javadoc Standard Doclet version 1.4.2_12 gives also warning(s).

With 'Private' members visibility you get 1 warning:
D:\usr\OTI\workspaces\tests\v33\FullSource\org.eclipse.core.resources\src\org\eclipse\core\internal\resources\ProjectContentTypes.java:32: warning - Tag @see: reference not found: ISelectionPolicy

With 'Public' members visibility you get 2 warnings:
D:\usr\OTI\workspaces\tests\v33\FullSource\org.eclipse.core.resources\src\org\eclipse\core\internal\resources\ProjectContentTypes.java:32: warning - Tag @see: reference not found: ISelectionPolicy
D:\usr\OTI\workspaces\tests\v33\FullSource\org.eclipse.core.resources\src\org\eclipse\core\internal\resources\ProjectContentTypes.java:219: warning - Tag @see: reference not found: ISelectionPolicy
Comment 5 Michael Valenta CLA 2006-06-28 11:37:42 EDT 
The code in question is not mine. If this is really a Javadoc error, please let John Arthorne know (or more this bug to Platform/Resources)
Comment 6 Frederic Fusier CLA 2006-06-28 11:42:08 EDT 
The only way not to have these warnings while generating using javadoc.exe
1.4.2 is to fully qualified the inner class reference
=> JDT/Core compiler is in sync' with javadoc.exe behavior
Comment 7 John Arthorne CLA 2006-06-28 11:46:51 EDT 
Fixed.
Comment 8 John Arthorne CLA 2006-06-28 15:07:45 EDT 
Frederic, if I qualify the reference with:

@see IContentTypeManager.ISelectionPolicy

I still get a compile error in 3.3. In bug 96237 it just says a qualifier such as "outer.inner" is required. It would be strange to require a full package qualifier only for inner types.  In Eclipse 3.2 there is no complaint.
Comment 9 Frederic Fusier CLA 2006-06-28 17:22:22 EDT 
John, you're right this is in fact a bug of javadoctool (ID: 4464323) and I wrongly sync' JDT/Core compiler on this boggus behavior. I take back this bug on my side to revert on expected behavior (ie. also accept enclosing type(s) qualification)
Comment 10 Frederic Fusier CLA 2006-07-02 08:35:10 EDT 
Back to "normal" behavior. Qualified reference does not need to be complete to avoid warning, just to start from the top level type is enough (if visible of course...).

Released for 3.3 M1 in HEAD stream.
Comment 11 Frederic Fusier CLA 2006-08-04 12:52:16 EDT 
Verified for 3.3 M1 using build I20060804-0010.