Added some documentation for possibly non-obvious methods

cdk · Dec 9, 2010 · 851c4be · 851c4be
1 parent 1060652
commit 851c4be
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/src/main/org/openscience/cdk/tools/periodictable/PeriodicTable.java b/src/main/org/openscience/cdk/tools/periodictable/PeriodicTable.java
@@ -150,6 +150,12 @@ private static void readPEneg() throws IOException {
         }
     }
 
+    /** 
+     * Get the Van der Waals radius for the element in question.
+     *
+     * @param symbol The symbol of the element
+     * @return the van der waals radius
+     */
     @TestMethod("testTable")
     public static Double getVdwRadius(String symbol) {
         initialize();
@@ -230,6 +236,12 @@ public static Double getPaulingElectronegativity(String symbol) {
         else return element.getPaulingEneg();
     }
 
+    /*
+     * Get the symbol for the specified atomic number.
+     *
+     * @param atomicNumber the atomic number of the element
+     * @return the corresponding symbol
+     */
     @TestMethod("testTable")
     public static String getSymbol(int atomicNumber) {
         initialize();
@@ -238,6 +250,11 @@ public static String getSymbol(int atomicNumber) {
         else return element.getSymbol();
     }
 
+    /**
+     * Return the number of elements currently considered in the periodic table.
+     *
+     * @return the number of elements in the periodic table
+     */
     @TestMethod("testTable")
     public static int getElementCount() {
         initialize();