API Stability Status Mark


Back to Main Index

Below are the texts used to mark API stability in the API documentation, note :

  1. May not all classes/functions/etc. are documented already.
  2. The mark should be interpreted as an approximation value, there is no guarantee that the marks are 100% match/correct with the real code condition.
Marks Explanations
preliminary experiment
  • The API is still very unstable.
  • Future releases will most likely to be not backward compatible.
experiment
  • The API is still unstable.
  • Future releases may not 100% backward compatible.
beta
  • The API may still unstable since the code is still under heavy debugging.
  • Future releases should be backward compatible unless major bugs have been found.
pretty stable
  • The API should be stable but the code still under further debugging.
  • Future releases should be almost 100% backward compatible unless major bugs have been found.
  • User code changes (because of API incompatibilities) should be mainly concerned with renaming function calls.
stable
  • The API should be stable and the code is not under further debugging unless "hidden" bugs suddenly found.
  • Future release will be almost 100% backward compatible.
  • At the worst case there will be "deprecated" compatibility functions so that old user code will still compile. However, caution must be taken here since the "deprecated" compatibility functions might be removed after some stable releases (especially when VortexGE has become near version 1.0.0).
very stable
  • The API is almost 100% stable (frozen).
  • Future release will be 100% backward compatible.
  • Currently there is no part of VortexGE API marked with "very stable".
deprecated
  • The API is deprecated.
  • Future releases should still support the older API via compatibility functions (if possible).
  • Using deprecated API is not recommended since it is subject to be removed (especially when VortexGE has become near and nearer to version 1.0.0).


Back to Main Index