Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "PTP/policy/api"
(New page: = PTP API Policy = This document provides the current API Policy for PTP. == Declared APIs == The declared APIs in PTP are provided as public and must be documented using Javadoc comment...) |
(→PTP API Policy) |
||
| Line 1: | Line 1: | ||
| − | |||
This document provides the current API Policy for PTP. | This document provides the current API Policy for PTP. | ||
Revision as of 11:18, 19 May 2010
This document provides the current API Policy for PTP.
Declared APIs
The declared APIs in PTP are provided as public and must be documented using Javadoc comments. Extension points are also considered API and must be documented.
The API compatibility between different versions of PTP should reflectd by the version numbers following the Eclipse versioning policy.
Changes to the API, such as addind new APIs or deprecating old APIs must be documented (e.g. in Bugzilla) and communicated to the community (e.g. via the mailing lists).
Deprecated API should be available for at lease one major release.
Provisional and Internal APIs
Provisional APIs should be used while development is occurring. Provisional APIs can be promoted to declared APIs if they are considered stable, or can be removed if no longer needed or used. In either case, the community should be notified.