Difference between revisions of "Documentation Roadmap"

From Open Babel
Jump to: navigation, search
Line 13: Line 13:
 
* generic.h
 
* generic.h
 
* mol.h -- Good progress, but not finished yet
 
* mol.h -- Good progress, but not finished yet
* obmolecformat.h
 
 
* parsmart.h -- also link to [[SMARTS]]
 
* parsmart.h -- also link to [[SMARTS]]
* xml.h
 
  
 
==Lower Priority Headers==
 
==Lower Priority Headers==
  
These headers also need documentation improvements, but are less relevant to external users (or already have better documentation than those above). (~26% of total)
+
These headers also need documentation improvements, but are less relevant to external users. Many also have better documentation than those above. Not all methods and class data are documented.
  
 
* bitvec.h
 
* bitvec.h
 
* chains.h
 
* chains.h
 
* grid.h
 
* grid.h
* kinetics.h -- Initial notes, although not all methods covered yet
+
* kinetics.h
 
* matrix.h
 
* matrix.h
 
* molchrg.h
 
* molchrg.h
Line 32: Line 30:
 
* rotor.h
 
* rotor.h
 
* typer.h
 
* typer.h
 +
* xml.h
  
 
==Completed==
 
==Completed==
  
These headers have completed documentation updates (~50% of total):
+
These headers have completed documentation updates (~50% of total). This includes all methods, data, sample code, brief and detailed descriptions of all classes.
  
 
* atom.h
 
* atom.h
Line 49: Line 48:
 
* oberror.h
 
* oberror.h
 
* obiter.h
 
* obiter.h
 +
* obmolecformat.h
 
* obutil.h
 
* obutil.h
 
* plugininter.h
 
* plugininter.h

Revision as of 08:34, 26 February 2007

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 (~23% of total)

  • chiral.h -- see ChiralData for some notes
  • fingerprint.h -- also links to Fingerprint
  • forcefield.h -- Almost completely finished
  • generic.h
  • mol.h -- Good progress, but not finished yet
  • parsmart.h -- also link to SMARTS

Lower Priority Headers

These headers also need documentation improvements, but are less relevant to external users. Many also have better documentation than those above. Not all methods and class data are documented.

  • bitvec.h
  • chains.h
  • grid.h
  • kinetics.h
  • matrix.h
  • molchrg.h
  • patty.h
  • phmodel.h
  • rand.h
  • rotor.h
  • typer.h
  • xml.h

Completed

These headers have completed documentation updates (~50% of total). This includes all methods, data, sample code, brief and detailed descriptions of all classes.

  • atom.h
  • base.h
  • bond.h
  • canon.h
  • bondtyper.h
  • data.h
  • internalcoord.h
  • lineend.h
  • dlhandler.h
  • obconversion.h
  • oberror.h
  • obiter.h
  • obmolecformat.h
  • obutil.h
  • plugininter.h
  • reaction.h
  • ring.h
  • rotamer.h
  • math/vector3.h
  • math/matrix3x3.h