Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added @link's to documentation

Change-Id: I379d454f7fb9fb655c6b4320d8c2bd88c2ed2d0c
Signed-off-by: Egon Willighagen <egonw@users.sourceforge.net>
  • Loading branch information...
commit 102bad653ac5a11cb59579aec3b7ca141ab03e4c 1 parent dc90dd2
@johnmay johnmay authored egonw committed
Showing with 24 additions and 17 deletions.
  1. +24 −17 src/main/org/openscience/cdk/geometry/GeometryTools.java
View
41 src/main/org/openscience/cdk/geometry/GeometryTools.java
@@ -969,7 +969,7 @@ public static double getLength2D(IBond bond) {
/**
- * Determines if all this AtomContainer's atoms contain 2D coordinates. If any atom
+ * Determines if all this {@link IAtomContainer}'s atoms contain 2D coordinates. If any atom
* is null or has unset 2D coordinates this method will return false.
*
* @param container the atom container to examine
@@ -996,15 +996,18 @@ public static boolean has2DCoordinates(IAtomContainer container) {
}
/**
- * Determines the coverage of this containers 2D coordinates. If all atoms
- * are non-null and have 2D coordinates this method will return 'FULL'. If
- * one or more atoms does have 2D coordinates and any others atoms are null
- * or are missing 2D coordinates this method will return PARTIAL. If all atoms
- * are null or are all missing 2D coordinates this method will return NONE. If
- * the provided container is null NONE is also returned.
+ * Determines the coverage of this {@link IAtomContainer}'s 2D coordinates. If all atoms are
+ * non-null and have 2D coordinates this method will return {@link CoordinateCoverage#FULL}. If
+ * one or more atoms does have 2D coordinates and any others atoms are null or are missing 2D
+ * coordinates this method will return {@link CoordinateCoverage#PARTIAL}. If all atoms
+ * are null or are all missing 2D coordinates this method will return {@link CoordinateCoverage#NONE}. If
+ * the provided container is null {@link CoordinateCoverage#NONE} is also returned.
*
* @param container the container to inspect
- * @return FULL, PARTIAL or NONE depending on the number of 2D coordinates pressent
+ *
+ * @return {@link CoordinateCoverage#FULL}, {@link CoordinateCoverage#PARTIAL} or {@link CoordinateCoverage#NONE}
+ * depending on the number of 3D coordinates present
+ *
* @see CoordinateCoverage
* @see #has2DCoordinates(org.openscience.cdk.interfaces.IAtomContainer)
* @see #get3DCoordinateCoverage(org.openscience.cdk.interfaces.IAtomContainer)
@@ -1035,7 +1038,8 @@ public static CoordinateCoverage get2DCoordinateCoverage(IAtomContainer containe
*
* @param container the molecule to be considered
* @return 0 no 2d, 1=some, 2= for each atom
- * @deprecated use get2DCoordinateCoverage for determining partial coordinates
+ * @deprecated use {@link #get2DCoordinateCoverage(org.openscience.cdk.interfaces.IAtomContainer)} for determining
+ * partial coordinates
* @see #get2DCoordinateCoverage(org.openscience.cdk.interfaces.IAtomContainer)
*/
@Deprecated
@@ -1091,7 +1095,7 @@ public static boolean has2DCoordinates(IBond bond) {
/**
- * Determines if all this AtomContainer's atoms contain 3D coordinates. If any atom
+ * Determines if all this {@link IAtomContainer}'s atoms contain 3D coordinates. If any atom
* is null or has unset 3D coordinates this method will return false. If the provided
* container is null false is returned.
*
@@ -1118,15 +1122,18 @@ public static boolean has3DCoordinates(IAtomContainer container) {
}
/**
- * Determines the coverage of this containers 3D coordinates. If all atoms
- * are non-null and have 3D coordinates this method will return 'FULL'. If
- * one or more atoms does have 3D coordinates and any others atoms are null
- * or are missing 3D coordinates this method will return PARTIAL. If all atoms
- * are null or are all missing 3D coordinates this method will return NONE. If
- * the provided container is null NONE is also returned.
+ * Determines the coverage of this {@link IAtomContainer}'s 3D coordinates. If all atoms are
+ * non-null and have 3D coordinates this method will return {@link CoordinateCoverage#FULL}. If
+ * one or more atoms does have 3D coordinates and any others atoms are null or are missing 3D
+ * coordinates this method will return {@link CoordinateCoverage#PARTIAL}. If all atoms are
+ * null or are all missing 3D coordinates this method will return {@link CoordinateCoverage#NONE}.
+ * If the provided container is null {@link CoordinateCoverage#NONE} is also returned.
*
* @param container the container to inspect
- * @return FULL, PARTIAL or NONE depending on the number of 3D coordinates pressent
+ *
+ * @return {@link CoordinateCoverage#FULL}, {@link CoordinateCoverage#PARTIAL} or {@link CoordinateCoverage#NONE}
+ * depending on the number of 3D coordinates present
+ *
* @see CoordinateCoverage
* @see #has3DCoordinates(org.openscience.cdk.interfaces.IAtomContainer)
* @see #get2DCoordinateCoverage(org.openscience.cdk.interfaces.IAtomContainer)
Please sign in to comment.
Something went wrong with that request. Please try again.