diff --git a/src/main/org/openscience/cdk/graph/AtomContainerAtomPermutor.java b/src/main/org/openscience/cdk/graph/AtomContainerAtomPermutor.java index b5f1a61ef9..5b97901c1f 100755 --- a/src/main/org/openscience/cdk/graph/AtomContainerAtomPermutor.java +++ b/src/main/org/openscience/cdk/graph/AtomContainerAtomPermutor.java @@ -1,10 +1,5 @@ /* - * $RCSfile$ - * $Author$ - * $Date$ - * $Revision$ - * - * Copyright (C) 1997-2007 The Chemistry Development Kit (CDK) project + * Copyright (C) 1997-2012 The Chemistry Development Kit (CDK) project * * Contact: cdk-devel@lists.sourceforge.net * @@ -25,7 +20,6 @@ * You should have received a copy of the GNU Lesser General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. - * */ package org.openscience.cdk.graph; @@ -34,21 +28,32 @@ import org.openscience.cdk.Atom; import org.openscience.cdk.interfaces.IAtom; import org.openscience.cdk.interfaces.IAtomContainer; +import org.openscience.cdk.tools.LoggingTool; /** - * This class allows to iterate trough the set of all possible - * permutations of the atom order in a given atom container. - * It allows to check for a dependency of algorithm results - * on the atom order. - * - *

The permutation code here is based on a pseudo code example - * on a tutorial site created and maintained by Phillip P. Fuchs: - * http://www.geocities.com/permute_it/pseudo2.html. - * - *@author steinbeck + * This class iterates through all possible permutations of the atom order in a + * given atom container. These permutations ensure that the results of an + * algorithm are independent of atom order. + *

+ *

{@code
+ *
+ * IAtomContainer        container = ...;
+ * AtomContainerPermutor permutor  = new AtomContainerAtomPermutor(container);
+ *
+ * while (permutor.hasNext()) {
+ *     IAtomContainer permutation = permutor.next();
+ * }
+ *
+ * }
+ *

+ * The permutation code here is based on a tutorial by Phillip P. Fuchs. + * + * @author steinbeck + * @see + * Phillip P. Fuchs Tutorial * @cdk.githash - *@cdk.created 2005-05-04 - *@cdk.keyword permutation + * @cdk.created 2005-05-04 + * @cdk.keyword permutation */ public class AtomContainerAtomPermutor extends AtomContainerPermutor {