Bug 98984 - Incorrect JavaDoc comment generated
Summary: Incorrect JavaDoc comment generated
Status: CLOSED WORKSFORME
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.1   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.1.2   Edit
Assignee: JDT-Core-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-06-08 11:38 EDT by Lawrence Mandel CLA
Modified: 2006-05-18 17:17 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Lawrence Mandel CLA 2005-06-08 11:38:48 EDT
I created an Eclipse job that extends org.eclipse.core.runtime.jobs.Job. I
implemented protected IStatus run(IProgressMonitor monitor) as required and when
I generate the JavaDoc comment for this method the following is produced.

/* (non-Javadoc)
 * @see
org.eclipse.core.internal.jobs.InternalJob#run(org.eclipse.core.runtime.IProgressMonitor)
 */

This is automatically flagged as the following warning in RC1.
"Discouraged access: The type InternalJob is not accessible due to restriction
on required library
D:\eclipse\I20050607\eclipse\plugins\org.eclipse.core.runtime_3.1.0.jar"

As the org.eclipse.core.runtime.jobs.job class defines the abstract run method
it seems to me that the comment should refer to this method and not the one in
InternalJob. (Note: I do not reference InternalJob anywhere in my code.) Also,
InternalJob is internal and for consistency the platform should be smart enough
to identify situations such as these.
Comment 1 Rafael Chaves CLA 2005-06-08 13:29:25 EDT
I could not reproduce this with n200506080010. The Job class overrides the run
method from InternalJob, and the generated javadoc I get refer's to Job's run
(which is API).
Comment 2 Frederic Fusier CLA 2006-03-31 09:19:04 EST
Verified it works with 3.2 M6 and 3.1.2
Comment 3 Lawrence Mandel CLA 2006-05-18 17:17:09 EDT
Verified on 3.1.2 RC4.
Comment 4 Lawrence Mandel CLA 2006-05-18 17:17:26 EDT
Closing bug.