Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.62 KB

ApiRemovalProcess.md

File metadata and controls

32 lines (22 loc) · 1.62 KB

API removal process

See Eclipse Project Deprecation Policy for more information.

For new API planned removals use:

  • For Java code use the @Deprecated annotation (see below for an example) and optional additional Javadoc. An extra entry in the removal document from removal document is not necessary anymore
  • If appropriate the @noextend @noreference and @noinstantiate Javadoc annotation should be added to code

PMC approval for planned API removal is required, either via the pull request or via the mailing list After 2 years of announced deletion, the API can be removed

Javadoc generates a detailed list of forRemoval API which is also linked to in the removal document

Example of a deprecation comment:

* XXX
 * @noreference
 * @noextend
 * @noimplement
 * @deprecated This XXX (class/method/field) will be removed in a future release. Use XXX instead.
 */
@Deprecated(forRemoval = true, since = "4.16")
  • The PMC may decide to back out of an API removal
  • In general, removing a deprecated API does NOT cause the increase of the major version segment.

Software tests and test utilities are not considered API and can be changed and deleted at any time.