[Cdk-commits] SF.net SVN: cdk: [8963] trunk/cdk/src/org/openscience/cdk/tools/ CDKHydrogenAdder.java

[<eg...@us...>]

Revision: 8963
          http://cdk.svn.sourceforge.net/cdk/?rev=8963&view=rev
Author:   egonw
Date:     2007-09-26 01:16:55 -0700 (Wed, 26 Sep 2007)

Log Message:
-----------
Added example code in the JavaDoc.

Modified Paths:
--------------
    trunk/cdk/src/org/openscience/cdk/tools/CDKHydrogenAdder.java

Modified: trunk/cdk/src/org/openscience/cdk/tools/CDKHydrogenAdder.java
===================================================================
--- trunk/cdk/src/org/openscience/cdk/tools/CDKHydrogenAdder.java	2007-09-25 16:16:30 UTC (rev 8962)
+++ trunk/cdk/src/org/openscience/cdk/tools/CDKHydrogenAdder.java	2007-09-26 08:16:55 UTC (rev 8963)
@@ -38,7 +38,28 @@
 
 /**
  * Assumes CDK atom types to be detected and adds missing hydrogens based on the
- * atom typing.
+ * atom typing:
+ * <pre>
+ *   IMolecule methane = new Molecule();
+ *   IAtom carbon = new Atom("C");
+ *   methane.addAtom(carbon);
+ *   CDKHydrogenAdder adder = new CDKHydrogenAdder();
+ *   adder.addImplicitHydrogens(methane);
+ *   int atomCount = methane.getAtomCount(); // = 1
+ * </pre>
+ *
+ * <p>If you want to add the hydrogens to a specific atom only,
+ * use this example:
+ * <pre>
+ *   IMolecule ethane = new Molecule();
+ *   IAtom carbon1 = new Atom("C");
+ *   IAtom carbon2 = new Atom("C");
+ *   ethane.addAtom(carbon1);
+ *   ethane.addAtom(carbon2);
+ *   CDKHydrogenAdder adder = new CDKHydrogenAdder();
+ *   adder.addExplicitHydrogens(ethane, carbon1);
+ *   int atomCount = ethane.getAtomCount(); // = 5
+ * </pre>
  * 
  * @author     egonw
  * @cdk.module valencycheck


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.