Merge pull request #232 from egonw/patch/isotopeJavaDoc

Extended the JavaDoc to point to the data source (closes #1381)

base/core/src/main/java/org/openscience/cdk/config/IsotopeFactory.java

@@ -32,7 +32,9 @@
 import org.openscience.cdk.tools.periodictable.PeriodicTable;
 
 /**
- * Used to store and return data of a particular isotope.
+ * Used to store and return data of a particular isotope. The classes
+ * {@link Isotopes} extends this class and is to be used to get isotope
+ * information.
  *
  * @cdk.module core
  * @cdk.githash

base/core/src/main/java/org/openscience/cdk/config/Isotopes.java

@@ -1,5 +1,5 @@
 /* Copyright (C) 2001-2007  Christoph Steinbeck <steinbeck@users.sf.net>
- *                    2013  Egon Willighagen <egonw@users.sf.net>
+ *               2013,2016  Egon Willighagen <egonw@users.sf.net>
  *
  * Contact: cdk-devel@lists.sourceforge.net
  *
@@ -36,8 +36,14 @@
 import org.openscience.cdk.tools.periodictable.PeriodicTable;
 
 /**
- * List of isotopes. Data is taken from the Blue Obelisk Data Repository,
- * version 10.
+ * List of isotopes. Data is taken from the <a href="https://github.com/egonw/bodr">Blue Obelisk Data Repository</a>,
+ * <a href="https://github.com/egonw/bodr/releases/tag/BODR-10">version 10</a> {@cdk.cite BODR10}.
+ * The data set is described in the first Blue Obelisk paper {@cdk.cite Guha2006}.
+ *
+ * <p>The <code>isotopes.dat</code> file that is used by this class is a binary class
+ * of this data, improving loading times over the BODR XML representation. It is created
+ * from the original BODR files using tools from the <code>cdk-build-util</code>
+ * repository.
  *
  * @author      egonw
  * @cdk.module  core

pom.xml

@@ -527,7 +527,7 @@
                     <tagletArtifact>
                         <groupId>org.openscience.cdk</groupId>
                         <artifactId>cdk-build-utils</artifactId>
-                        <version>1.0.2.4</version>
+                        <version>1.0.2.5</version>
                     </tagletArtifact>
                 </configuration>
                 <executions>