Difference between revisions of "Developer:API"

From Open Babel
Jump to: navigation, search
(Development Code)
 
Line 13: Line 13:
 
==Development Code==
 
==Development Code==
 
* The [http://openbabel.org/dev-api/ ''beta'' API Documentation] (Updated nightly)
 
* The [http://openbabel.org/dev-api/ ''beta'' API Documentation] (Updated nightly)
** 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 [[Git]] repository master.
 
** An [http://openbabel.org/dev-api/docbuild.out error report] is also available
 
** An [http://openbabel.org/dev-api/docbuild.out error report] is also available
  
 
[[Category:Developer]]
 
[[Category:Developer]]

Latest revision as of 11:26, 9 June 2013

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 Code

  • The beta API Documentation (Updated nightly)
    • This is intended for developers working with the bleeding-edge development code from the Git repository master.
    • An error report is also available