Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

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
John May authored July 20, 2012 egonw committed July 21, 2012
41  src/main/org/openscience/cdk/geometry/GeometryTools.java
@@ -969,7 +969,7 @@ public static double getLength2D(IBond bond) {
969 969
 
970 970
 
971 971
 	/**
972  
-	 * Determines if all this AtomContainer's atoms contain 2D coordinates. If any atom
  972
+	 * Determines if all this {@link IAtomContainer}'s atoms contain 2D coordinates. If any atom
973 973
      * is null or has unset 2D coordinates this method will return false.
974 974
 	 *
975 975
 	 * @param  container  the atom container to examine
@@ -996,15 +996,18 @@ public static boolean has2DCoordinates(IAtomContainer container) {
996 996
 	}
997 997
 
998 998
     /**
999  
-     * Determines the coverage of this containers 2D coordinates. If all atoms
1000  
-     * are non-null and have 2D coordinates this method will return 'FULL'. If
1001  
-     * one or more atoms does have 2D coordinates and any others atoms are null
1002  
-     * or are missing 2D coordinates this method will return PARTIAL. If all atoms
1003  
-     * are null or are all missing 2D coordinates this method will return NONE. If
1004  
-     * the provided container is null NONE is also returned.
  999
+     * Determines the coverage of this {@link IAtomContainer}'s 2D coordinates. If all atoms are
  1000
+     * non-null and have 2D coordinates this method will return {@link CoordinateCoverage#FULL}. If
  1001
+     * one or more atoms does have 2D coordinates and any others atoms are null or are missing 2D
  1002
+     * coordinates this method will return {@link CoordinateCoverage#PARTIAL}. If all atoms
  1003
+     * are null or are all missing 2D coordinates this method will return {@link CoordinateCoverage#NONE}. If
  1004
+     * the provided container is null {@link CoordinateCoverage#NONE} is also returned.
1005 1005
      *
1006 1006
      * @param container the container to inspect
1007  
-     * @return FULL, PARTIAL or NONE depending on the number of 2D coordinates pressent
  1007
+     *
  1008
+     * @return {@link CoordinateCoverage#FULL}, {@link CoordinateCoverage#PARTIAL} or {@link CoordinateCoverage#NONE}
  1009
+     *         depending on the number of 3D coordinates present
  1010
+     *
1008 1011
      * @see CoordinateCoverage
1009 1012
      * @see #has2DCoordinates(org.openscience.cdk.interfaces.IAtomContainer)
1010 1013
      * @see #get3DCoordinateCoverage(org.openscience.cdk.interfaces.IAtomContainer)
@@ -1035,7 +1038,8 @@ public static CoordinateCoverage get2DCoordinateCoverage(IAtomContainer containe
1035 1038
 	 *
1036 1039
 	 * @param container the molecule to be considered
1037 1040
      * @return    0 no 2d, 1=some, 2= for each atom
1038  
-     * @deprecated use get2DCoordinateCoverage for determining partial coordinates
  1041
+     * @deprecated use {@link #get2DCoordinateCoverage(org.openscience.cdk.interfaces.IAtomContainer)} for determining
  1042
+     *             partial coordinates
1039 1043
      * @see #get2DCoordinateCoverage(org.openscience.cdk.interfaces.IAtomContainer)
1040 1044
 	 */
1041 1045
 	@Deprecated
@@ -1091,7 +1095,7 @@ public static boolean has2DCoordinates(IBond bond) {
1091 1095
 
1092 1096
 
1093 1097
     /**
1094  
-     * Determines if all this AtomContainer's atoms contain 3D coordinates. If any atom
  1098
+     * Determines if all this {@link IAtomContainer}'s atoms contain 3D coordinates. If any atom
1095 1099
      * is null or has unset 3D coordinates this method will return false. If the provided
1096 1100
      * container is null false is returned.
1097 1101
      *
@@ -1118,15 +1122,18 @@ public static boolean has3DCoordinates(IAtomContainer container) {
1118 1122
     }
1119 1123
 
1120 1124
     /**
1121  
-     * Determines the coverage of this containers 3D coordinates. If all atoms
1122  
-     * are non-null and have 3D coordinates this method will return 'FULL'. If
1123  
-     * one or more atoms does have 3D coordinates and any others atoms are null
1124  
-     * or are missing 3D coordinates this method will return PARTIAL. If all atoms
1125  
-     * are null or are all missing 3D coordinates this method will return NONE. If
1126  
-     * the provided container is null NONE is also returned.
  1125
+     * Determines the coverage of this {@link IAtomContainer}'s 3D coordinates. If all atoms are
  1126
+     * non-null and have 3D coordinates this method will return {@link CoordinateCoverage#FULL}. If
  1127
+     * one or more atoms does have 3D coordinates and any others atoms are null or are missing 3D
  1128
+     * coordinates this method will return {@link CoordinateCoverage#PARTIAL}. If all atoms are
  1129
+     * null or are all missing 3D coordinates this method will return {@link CoordinateCoverage#NONE}.
  1130
+     * If the provided container is null {@link CoordinateCoverage#NONE} is also returned.
1127 1131
      *
1128 1132
      * @param container the container to inspect
1129  
-     * @return FULL, PARTIAL or NONE depending on the number of 3D coordinates pressent
  1133
+     *
  1134
+     * @return {@link CoordinateCoverage#FULL}, {@link CoordinateCoverage#PARTIAL} or {@link CoordinateCoverage#NONE}
  1135
+     *         depending on the number of 3D coordinates present
  1136
+     *
1130 1137
      * @see CoordinateCoverage
1131 1138
      * @see #has3DCoordinates(org.openscience.cdk.interfaces.IAtomContainer)
1132 1139
      * @see #get2DCoordinateCoverage(org.openscience.cdk.interfaces.IAtomContainer)

0 notes on commit 102bad6

Please sign in to comment.
Something went wrong with that request. Please try again.