Javadoc

Author: garydgregory

commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/MathArrays.java

@@ -286,7 +286,7 @@ public static int distanceInf(int[] p1, int[] p2) {
     }
 
     /**
-     * Specification of ordering direction.
+     * Enumerates specifications of ordering directions.
      */
     public enum OrderDirection {
         /** Constant for increasing direction. */

commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/dfp/DfpField.java

@@ -25,7 +25,7 @@
  */
 public class DfpField implements Field<Dfp> {
 
-    /** Enumerate for rounding modes. */
+    /** Enumerates rounding modes. */
     public enum RoundingMode {
 
         /** Rounds toward zero (truncation). */

commons-math-legacy-exception/src/main/java/org/apache/commons/math4/legacy/exception/util/LocalizedFormats.java

@@ -21,7 +21,7 @@
 import java.util.ResourceBundle;
 
 /**
- * Enumeration for localized messages formats used in exceptions messages.
+ * Enumerates localized messages formats used in exceptions messages.
  * <p>
  * The constants in this enumeration represent the available
  * formats as localized strings. These formats are intended to be

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/analysis/solvers/AllowedSolution.java

@@ -18,7 +18,7 @@
 package org.apache.commons.math4.legacy.analysis.solvers;
 
 
-/** The kinds of solutions that a {@link BracketedUnivariateSolver
+/** Enumerates the kinds of solutions that a {@link BracketedUnivariateSolver
  * (bracketed univariate real) root-finding algorithm} may accept as solutions.
  * This basically controls whether or not under-approximations and
  * over-approximations are allowed.

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/fitting/leastsquares/GaussNewtonOptimizer.java

@@ -48,7 +48,7 @@
  */
 public class GaussNewtonOptimizer implements LeastSquaresOptimizer {
 
-    /** The decomposition algorithm to use to solve the normal equations. */
+    /** Enumerates the decomposition algorithm to use to solve the normal equations. */
     //TODO move to linear package and expand options?
     public enum Decomposition {
         /**

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ml/clustering/KMeansPlusPlusClusterer.java

@@ -40,7 +40,7 @@
  */
 public class KMeansPlusPlusClusterer<T extends Clusterable> extends Clusterer<T> {
 
-    /** Strategies to use for replacing an empty cluster. */
+    /** Enumerates strategies to use for replacing an empty cluster. */
     public enum EmptyClusterStrategy {
 
         /** Split the cluster with largest distance variance. */

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/events/Action.java

@@ -17,7 +17,7 @@
 
 package org.apache.commons.math4.legacy.ode.events;
 
-/** Enumerate for actions to be performed when an event occurs during ODE integration.
+/** Enumerates for actions to be performed when an event occurs during ODE integration.
  * @since 3.6
  */
 public enum Action {

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/events/FilterType.java

@@ -19,11 +19,10 @@
 
 import org.apache.commons.math4.legacy.exception.MathInternalError;
 
-/** Enumerate for {@link EventFilter filtering events}.
+/** Enumerates {@link EventFilter filtering events}.
  *
  * @since 3.2
  */
-
 public enum FilterType {
 
     /** Constant for triggering only decreasing events.

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizerBounds.java

@@ -17,7 +17,7 @@
 
 package org.apache.commons.math4.legacy.ode.sampling;
 
-/** {@link StepNormalizer Step normalizer} bounds settings. They influence
+/** Enumerates {@link StepNormalizer Step normalizer} bounds settings. They influence
  * whether the underlying fixed step size step handler is called for the first
  * and last points. Note that if the last point coincides with a normalized
  * point, then the underlying fixed step size step handler is always called,

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/ode/sampling/StepNormalizerMode.java

@@ -18,7 +18,7 @@
 package org.apache.commons.math4.legacy.ode.sampling;
 
 
-/** {@link StepNormalizer Step normalizer} modes. Determines how the step size
+/** Enumerates {@link StepNormalizer Step normalizer} modes. Determines how the step size
  * is interpreted.
  * @see FieldStepNormalizer
  * @see StepNormalizer