Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Eclipse/API Central/Deprecation Policy"
< Eclipse | API Central
(New page: This page contains draft Eclipse Project guidelines on API deprecation. = References = Architecture Council/Meetings/API Deprecation 20080119) |
|||
Line 1: | Line 1: | ||
This page contains draft [[Eclipse Project]] guidelines on API deprecation. | This page contains draft [[Eclipse Project]] guidelines on API deprecation. | ||
+ | = What is Deprecation? = | ||
+ | |||
+ | Despite our best efforts, we don't always craft API that remains perfect forever. Often new and better approaches come along that supersede old ways of doing things. API deprecation is used to inform API clients that a particular API element is no longer recommended. The deprecation comment should describe the reason for the deprecation, and directions for how to replace their usage with the new recommended way of doing things. | ||
+ | |||
+ | = Identifying Deprecated API = | ||
+ | |||
+ | == Java API == | ||
+ | |||
+ | == Extension Points == | ||
+ | |||
+ | = Retention of Deprecated API = | ||
= References = | = References = | ||
[[Architecture Council/Meetings/API Deprecation 20080119]] | [[Architecture Council/Meetings/API Deprecation 20080119]] | ||
+ | [http://java.sun.com/j2se/1.4.2/docs/guide/misc/deprecation/deprecation.html Java Deprecation Guidelines] |
Revision as of 10:53, 23 October 2009
This page contains draft Eclipse Project guidelines on API deprecation.
Contents
What is Deprecation?
Despite our best efforts, we don't always craft API that remains perfect forever. Often new and better approaches come along that supersede old ways of doing things. API deprecation is used to inform API clients that a particular API element is no longer recommended. The deprecation comment should describe the reason for the deprecation, and directions for how to replace their usage with the new recommended way of doing things.
Identifying Deprecated API
Java API
Extension Points
Retention of Deprecated API
References
Architecture Council/Meetings/API Deprecation 20080119 Java Deprecation Guidelines