Difference between revisions of "Documentation Roadmap"

From Open Babel
Jump to: navigation, search
 
Line 1: Line 1:
For the upcoming 2.1 releases, one goal is to  
+
For the upcoming 2.1 releases, one goal is to complete documentation for all classes and public headers. Each significant class should have at least one set of example code, as well as some documentation for any public method.
 +
 
 +
This page tracks progress towards that goal, one header at a time.
 +
 
 +
The current set of [http://openbabel.sourceforge.net/dev-api/ developmental API documentation] is made at least once a month, and may lag this progress document.
  
 
==Priority Headers==
 
==Priority Headers==
 +
 +
These headers are the most important to be updated ASAP (40% of total headers).
 +
 +
* chiral.h
 +
* ring.h
 +
* fingerprint.h
 +
* generic.h
 +
* kinetics.h
 +
* mol.h
 +
* obmolecformat.h
 +
* plugininter.h
 +
* parsmart.h
 +
* xml.h
  
 
==Lower Priority Headers==
 
==Lower Priority Headers==
Line 22: Line 39:
 
==Completed==
 
==Completed==
  
These headers have completed documentation updates. (13 / ) = X%
+
These headers have completed documentation updates. These currently represent 52% progress.
  
 
* atom.h
 
* atom.h
Line 37: Line 54:
 
* math/vector3.h
 
* math/vector3.h
 
* math/matrix3x3.h
 
* math/matrix3x3.h
 
http://openbabel.sourceforge.net/dev-api/
 
  
 
[[Category:Contribute]]
 
[[Category:Contribute]]

Revision as of 13:24, 28 December 2006

For the upcoming 2.1 releases, one goal is to complete documentation for all classes and public headers. Each significant class should have at least one set of example code, as well as some documentation for any public method.

This page tracks progress towards that goal, one header at a time.

The current set of developmental API documentation is made at least once a month, and may lag this progress document.

Priority Headers

These headers are the most important to be updated ASAP (40% of total headers).

  • chiral.h
  • ring.h
  • fingerprint.h
  • generic.h
  • kinetics.h
  • mol.h
  • obmolecformat.h
  • plugininter.h
  • parsmart.h
  • xml.h

Lower Priority Headers

These headers also need documentation improvements, but are less relevant to external users (or already have better documentation than those above).

  • bitvec.h
  • chains.h
  • grid.h
  • molchrg.h
  • newlinebuf.h
  • obutil.h
  • obiter.h
  • patty.h
  • phmodel.h
  • rand.h
  • rotor.h
  • typer.h

Completed

These headers have completed documentation updates. These currently represent 52% progress.

  • atom.h
  • base.h
  • bond.h
  • bondtyper.h
  • data.h
  • internalcoord.h
  • dlhandler.h
  • obconversion.h
  • oberror.h
  • reaction.h
  • rotamer.h
  • math/vector3.h
  • math/matrix3x3.h