Difference between revisions of "Documentation Roadmap"

From Open Babel
Jump to: navigation, search
Line 10: Line 10:
  
 
* chiral.h
 
* chiral.h
* ring.h
 
 
* fingerprint.h
 
* fingerprint.h
 
* forcefield.h  -- Almost completely finished
 
* forcefield.h  -- Almost completely finished
 
* generic.h
 
* generic.h
 
* kinetics.h
 
* kinetics.h
* mol.h
+
* mol.h -- Good progress, but not finished yet
 
* obmolecformat.h
 
* obmolecformat.h
* plugininter.h
 
 
* parsmart.h
 
* parsmart.h
 
* xml.h
 
* xml.h
Line 40: Line 38:
 
==Completed==
 
==Completed==
  
These headers have completed documentation updates. These currently represent 52% progress.
+
These headers have completed documentation updates.
  
 
* atom.h
 
* atom.h
Line 51: Line 49:
 
* obconversion.h
 
* obconversion.h
 
* oberror.h
 
* oberror.h
 +
* plugininter.h
 
* reaction.h
 
* reaction.h
 +
* ring.h
 
* rotamer.h
 
* rotamer.h
 
* math/vector3.h
 
* math/vector3.h

Revision as of 12:30, 20 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 (40% of total headers).

  • chiral.h
  • fingerprint.h
  • forcefield.h -- Almost completely finished
  • generic.h
  • kinetics.h
  • mol.h -- Good progress, but not finished yet
  • obmolecformat.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
  • lineend.h
  • molchrg.h
  • obutil.h
  • obiter.h -- Almost finished, just need to mark methods
  • patty.h
  • phmodel.h
  • rand.h
  • rotor.h
  • typer.h

Completed

These headers have completed documentation updates.

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