Bug 158951 - [model] IWorkingCopy should not be referenced in any javadoc comment of JavaModel methods
Summary: [model] IWorkingCopy should not be referenced in any javadoc comment of JavaM...
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.3   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.3 M3   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-09-27 07:15 EDT by Frederic Fusier CLA
Modified: 2006-10-30 12:17 EST (History)
1 user (show)

See Also:

Attachments
Proposed patch (18.49 KB, patch)
2006-09-28 04:20 EDT, Frederic Fusier CLA 		no flags Details | Diff
View All 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 Frederic Fusier CLA 2006-09-27 07:15:47 EDT 
As IWorkingCopy is globally deprecated (e.g. @deprecated tag in interface javadoc comment), there's no advice on each method to replace deprecated calls. Some of current method of JavaModel classes have some deprecated method f this interface which still have @see IWorkingCopy#... in javadoc comment.

All this kind of reference must be removed and replaced by a "Use {@link ...} instead." after @deprecated tag...

Note that this bug is a FUP of eclipse.tools.jdt newsgroup thread:
news://news.eclipse.org:119/ef0tkl$osb$1@utils.eclipse.org
Comment 1 Philipe Mulet CLA 2006-09-27 10:56:37 EDT 
Not sure why we would need to improve deprecated javadocs... similar to the implementation of the deprecated methods which is not guaranteed to use non deprecated code.
Comment 2 Frederic Fusier CLA 2006-09-27 11:20:31 EDT 
Agree that perhaps, javadoc comments of deprecated methods do not need to be modified. However, user still needs some piece of advice while seeing a deprecated warning on a method call. Currently, these advice do not exist in IWorkingCopy...

Either we add in IWorkingCopy javadoc comment a link to documentation which tells user how to use ICompilationUnit or - and I think it should be better - we add a @deprecated tag on each method with another new API method to use instead.
Comment 3 Frederic Fusier CLA 2006-09-28 04:20:45 EDT 
Created attachment 51065 [details]
Proposed patch

@deprecated tag added on all IWorkingCopy methods + fix some unlinked "Use ... instead" on other public @deprecated methods...
Comment 4 Frederic Fusier CLA 2006-09-29 13:10:44 EDT 
Released for 3.3 M3 in HEAD stream.
Comment 5 Olivier Thomann CLA 2006-10-30 12:17:14 EST 
Verified for 3.3 M3 using warm-up build I20061030-0010