Bug 68371 - Inconsistencies between javadoc compiler warnings and Sun tools
Summary: Inconsistencies between javadoc compiler warnings and Sun tools
Status: RESOLVED INVALID
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.0   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.0 RC4   Edit
Assignee: JDT-Core-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-06-23 15:30 EDT by DJ Houghton CLA
Modified: 2004-06-24 08:11 EDT (History)
1 user (show)

See Also:


Attachments
compiler options (31.47 KB, image/jpeg)
2004-06-23 15:31 EDT, DJ Houghton CLA
no flags Details
java file causing problems. (9.67 KB, text/plain)
2004-06-23 15:32 EDT, DJ Houghton CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description DJ Houghton CLA 2004-06-23 15:30:54 EDT
build 20040623-0010

I have the javadoc compiler warnings turned on and do not get any warnings
reported, but when the Sun javadoc tool is run against our code, it has some
warnings. Code assist also doesn't help me. (read: it just gives me the same
text that I already have)

The warnings seem to have to do with inner-classes defined within an interface.
Here are the javadoc tool warnings. 

I will attach the corresponding revision of IEclipsePreferences and my compiler
options.

---------------

/org.eclipse.core.runtime/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:97:

warning - Tag @see: can't 

find addNodeChangeListener(INodeChangeListener) in 
org.eclipse.core.runtime.preferences.IEclipsePreferences
/org.eclipse.core.runtime/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:97:

warning - Tag @see: can't 

find removeNodeChangeListener(INodeChangeListener) in 
org.eclipse.core.runtime.preferences.IEclipsePreferences
/org.eclipse.core.runtime/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:108:

warning - Tag @see: 

can't find addNodeChangeListener(INodeChangeListener) in 
org.eclipse.core.runtime.preferences.IEclipsePreferences
/org.eclipse.core.runtime/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:108:

warning - Tag @see: 

can't find removeNodeChangeListener(INodeChangeListener) in 
org.eclipse.core.runtime.preferences.IEclipsePreferences

/org.eclipse.core.runtime/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:214:

warning - Tag @see: 

can't find removeNodeChangeListener(INodeChangeListener) in 
org.eclipse.core.runtime.preferences.IEclipsePreferences
/org.eclipse.core.runtime/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:226:

warning - Tag @see: 

can't find addNodeChangeListener(INodeChangeListener) in 
org.eclipse.core.runtime.preferences.IEclipsePreferences

/org.eclipse.core.runtime/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:201:

warning - Tag @see: 

can't find addPreferenceChangeListener(IPreferenceChangeListener) in 

org.eclipse.core.runtime.preferences.IEclipsePreferences
/org.eclipse.core.runtime/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:201:

warning - Tag @see: 

can't find removePreferenceChangeListener(IPreferenceChangeListener) in 

org.eclipse.core.runtime.preferences.IEclipsePreferences

/org.eclipse.core.runtime/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:238:

warning - Tag @see: 

can't find removePreferenceChangeListener(IPreferenceChangeListener) in 

org.eclipse.core.runtime.preferences.IEclipsePreferences
/org.eclipse.core.runtime/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:250:

warning - Tag @see: 

can't find addPreferenceChangeListener(IPreferenceChangeListener) in 

org.eclipse.core.runtime.preferences.IEclipsePreferences
Comment 1 DJ Houghton CLA 2004-06-23 15:31:12 EDT
Created attachment 12753 [details]
compiler options
Comment 2 DJ Houghton CLA 2004-06-23 15:32:09 EDT
Created attachment 12754 [details]
java file causing problems.
Comment 3 DJ Houghton CLA 2004-06-23 16:19:12 EDT
Note that exporting your javadoc will help find errors by spilling warnings to
the console.

File -> Export -> Javadoc
Comment 4 Frederic Fusier CLA 2004-06-24 03:40:30 EDT
Your compiler options were correct and I also cannot see any error in Javadoc
comment.

My assumption here is that it should be some issues of Sun javadoc tool...
Most of reported errors are in javadoc comments of methods in inner classes. I
guess javadoc is not able to bind correctly references in this kind of comments
(inner classes in interface is perhaps something too complicated for javadoc
tool...)

The last 2 ones at line 238 and 250 are ununderstandable: it should be able to
resolve the reference since the method are just above or after... Again perhaps
javadoc tool is a little bit lost after having encountered inner classes in
interface...

Close as invalid due to the fact that obviously there are absolutely no error in
your javadoc comment :)
Comment 5 DJ Houghton CLA 2004-06-24 08:11:18 EDT
Jim, if there is an error with the javadoc tool, how does this effect our use of
the tool for sanity checking the javadoc for Eclipse?