Difference between revisions of "Documentation Roadmap"

From Open Babel
Jump to: navigation, search
m (Finish a few more headers)
Line 7: Line 7:
 
==Priority Headers==
 
==Priority Headers==
  
These headers are the most important to be updated ASAP (40% of total headers).
+
These headers are the most important to be updated ASAP (~23% of total)
 
+
 
* chiral.h
 
* chiral.h
 
* fingerprint.h
 
* fingerprint.h
Line 21: Line 20:
 
==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).
+
These headers also need documentation improvements, but are less relevant to external users (or already have better documentation than those above). (~26% of total)
  
 
* bitvec.h
 
* bitvec.h
 
* chains.h
 
* chains.h
 
* grid.h
 
* grid.h
* lineend.h
+
* matrix.h
 
* molchrg.h
 
* molchrg.h
 
* patty.h
 
* patty.h
Line 36: Line 35:
 
==Completed==
 
==Completed==
  
These headers have completed documentation updates.
+
These headers have completed documentation updates (~50% of total):
  
 
* atom.h
 
* atom.h
 
* base.h
 
* base.h
 
* bond.h
 
* bond.h
 +
* canon.h
 
* bondtyper.h
 
* bondtyper.h
 
* data.h
 
* data.h
 
* internalcoord.h
 
* internalcoord.h
 +
* lineend.h
 
* dlhandler.h
 
* dlhandler.h
 
* obconversion.h
 
* obconversion.h

Revision as of 15:57, 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 (~23% of total)

  • 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). (~26% of total)

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

Completed

These headers have completed documentation updates (~50% of total):

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