Difference between revisions of "Developer:API"

From Open Babel
Jump to: navigation, search
m (Added 2.1 snapshot docs)
m (Updated to correct links to API docs)
Line 1: Line 1:
 
The developer application program interface (API) is documented using the program [http://www.doxygen.org/ Doxygen] from the source code itself. It is updated for every major and minor version release.
 
The developer application program interface (API) is documented using the program [http://www.doxygen.org/ Doxygen] from the source code itself. It is updated for every major and minor version release.
  
Bug fix releases (e.g., 2.0.0, vs. 2.0.1, vs. 2.0.2) do not change API at all, although many times the documentation will be updated to correct errors or add additional documentation.
+
Bug fix releases (e.g., 2.0.0, vs. 2.0.1, vs. 2.0.2) do not change API at all, although the documentation may be updated to correct errors or add additional documentation.
  
 
Minor versions (e.g., 2.0 vs. 2.1) will add function calls, but will be otherwise backwards-compatible. Again, documentation may be updated to correct errors in the text or add additional documentation. Such changes should be considered to apply to older versions as well.
 
Minor versions (e.g., 2.0 vs. 2.1) will add function calls, but will be otherwise backwards-compatible. Again, documentation may be updated to correct errors in the text or add additional documentation. Such changes should be considered to apply to older versions as well.
  
==Current Documentation==
+
==Release Documentation==
* [http://openbabel.sourceforge.net/api/ 2.0.x API Documentation]
+
* [http://openbabel.sourceforge.net/api/ 2.1.0 API Documentation]
 +
* [http://openbabel.sourceforge.net/api/2.0.2 2.0.2 API Documentation]
  
 
==Development Snapshots==
 
==Development Snapshots==
* [http://openbabel.sourceforge.net/dev-api/ 2.1.x ''beta'' API Documentation] Updated monthly.
+
* [http://openbabel.sourceforge.net/dev-api/ 2.1.x ''beta'' API Documentation] (Updated monthly)
 
** This is intended for developers working with the bleeding-edge development code from the [[SVN]] repository trunk.
 
** This is intended for developers working with the bleeding-edge development code from the [[SVN]] repository trunk.
  
 
[[Category:Developer]]
 
[[Category:Developer]]

Revision as of 04:15, 23 April 2007

The developer application program interface (API) is documented using the program Doxygen from the source code itself. It is updated for every major and minor version release.

Bug fix releases (e.g., 2.0.0, vs. 2.0.1, vs. 2.0.2) do not change API at all, although the documentation may be updated to correct errors or add additional documentation.

Minor versions (e.g., 2.0 vs. 2.1) will add function calls, but will be otherwise backwards-compatible. Again, documentation may be updated to correct errors in the text or add additional documentation. Such changes should be considered to apply to older versions as well.

Release Documentation

Development Snapshots

  • 2.1.x beta API Documentation (Updated monthly)
    • This is intended for developers working with the bleeding-edge development code from the SVN repository trunk.