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 "MemoryAnalyzer/API policy"
m |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 4: | Line 4: | ||
== Declared API == | == Declared API == | ||
| − | The declared APIs in Memory Analyzer are provided as public and documented. The API compatibility between different versions of Memory Analyzer should | + | The declared APIs in Memory Analyzer are provided as public and documented. The API compatibility between different versions of Memory Analyzer should be reflected by the version numbers, following the Eclipse [http://wiki.eclipse.org/Version_Numbering versioning policy] <br> |
Changes to the API - addind new APIs or deprecating APIs should be documented (e.g. in Bugzilla) and communicated to the community (e.g. via the newsgroups).<br> | Changes to the API - addind new APIs or deprecating APIs should be documented (e.g. in Bugzilla) and communicated to the community (e.g. via the newsgroups).<br> | ||
| Line 13: | Line 13: | ||
== Provisional and internal API == | == Provisional and internal API == | ||
Provisional APIs should be used while development is occurring. If successfully adopted, they might become declared APIs. If not, they can be removed. In any situation, the community should be notified.<br> | Provisional APIs should be used while development is occurring. If successfully adopted, they might become declared APIs. If not, they can be removed. In any situation, the community should be notified.<br> | ||
| + | |||
| + | [[Category:Memory Analyzer]] | ||
Latest revision as of 03:11, 5 June 2013
Memory Analyzer API Policy
This document provides the current API Policy for Memory Analyzer.
Declared API
The declared APIs in Memory Analyzer are provided as public and documented. The API compatibility between different versions of Memory Analyzer should be reflected by the version numbers, following the Eclipse versioning policy
Changes to the API - addind new APIs or deprecating APIs should be documented (e.g. in Bugzilla) and communicated to the community (e.g. via the newsgroups).
Deprecated API should be available for at lease one major release.
Provisional and internal API
Provisional APIs should be used while development is occurring. If successfully adopted, they might become declared APIs. If not, they can be removed. In any situation, the community should be notified.