Jump to: navigation, search

Difference between revisions of "MemoryAnalyzer/API policy"

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 [versioning policy]http://wiki.eclipse.org/Version_Numbering<br>
+
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>
  
 
New APIs should be approved by the project lead.<br>
 
New APIs should be approved by the project lead.<br>

Revision as of 09:53, 4 May 2010

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 follow the Eclipse versioning policy

New APIs should be approved by the project lead.

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.


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.