Jump to: navigation, search

Difference between revisions of "MemoryAnalyzer/API policy"

m
 
(3 intermediate revisions by 2 users 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 follow the Eclipse [http://wiki.eclipse.org/Version_Numbering versioning policy] <br>
+
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>
  
New APIs should be approved by the project lead.<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>
  
Deprecated APIs should also be approved by the project lead. They should be notified for the community, and not be removed for at least 2 major releases.<br>
+
Deprecated API should be available for at lease one major release.
  
  
 
== 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.