From e0723d16df8e098969862a3ef50794f5366b2cef Mon Sep 17 00:00:00 2001
From: Gilles Sadowski <erans@apache.org>
Date: Mon, 26 Jul 2010 21:45:26 +0000
Subject: [PATCH] Corrected typos in some Javadoc comments.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@979458 13f79535-47bb-0310-9956-ffa450edef68
---
 .../BaseMultivariateRealOptimizer.java             | 11 +++++------
 .../DifferentiableMultivariateRealOptimizer.java   | 14 ++++++++------
 .../AbstractScalarDifferentiableOptimizer.java     |  2 +-
 .../general/AbstractScalarOptimizer.java           |  2 +-
 .../general/BaseAbstractScalarOptimizer.java       |  2 +-
 5 files changed, 16 insertions(+), 15 deletions(-)

diff --git a/src/main/java/org/apache/commons/math/optimization/BaseMultivariateRealOptimizer.java b/src/main/java/org/apache/commons/math/optimization/BaseMultivariateRealOptimizer.java
index 5cffa911a..affd19318 100644
--- a/src/main/java/org/apache/commons/math/optimization/BaseMultivariateRealOptimizer.java
+++ b/src/main/java/org/apache/commons/math/optimization/BaseMultivariateRealOptimizer.java
@@ -64,9 +64,9 @@ public interface BaseMultivariateRealOptimizer<T extends MultivariateRealFunctio
 
     /**
      * Get the number of iterations realized by the algorithm.
-     * The number of evaluations corresponds to the last call to the
-     * {@link #optimize(MultivariateRealFunction, GoalType, double[]) optimize}
-     * method. It is 0 if the method has not been called yet.
+     * The number of iterations corresponds to the last call to the
+     * {@code optimize} method. It is 0 if the method has not been
+     * called yet.
      *
      * @return the number of iterations.
      */
@@ -74,10 +74,9 @@ public interface BaseMultivariateRealOptimizer<T extends MultivariateRealFunctio
 
     /**
      * Get the number of evaluations of the objective function.
-     *
      * The number of evaluations corresponds to the last call to the
-     * {@link #optimize(T, GoalType, double[]) optimize}
-     * method. It is 0 if the method has not been called yet.
+     * {@code optimize} method. It is 0 if the method has not been
+     * called yet.
      *
      * @return the number of evaluations of the objective function.
      */
diff --git a/src/main/java/org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.java b/src/main/java/org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.java
index b4457cc3d..3e3aea3bf 100644
--- a/src/main/java/org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.java
+++ b/src/main/java/org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.java
@@ -21,10 +21,12 @@ import org.apache.commons.math.FunctionEvaluationException;
 import org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction;
 
 /**
- * This interface represents an optimization algorithm for {@link DifferentiableMultivariateRealFunction
- * scalar differentiable objective functions}.
- * <p>Optimization algorithms find the input point set that either {@link GoalType
- * maximize or minimize} an objective function.</p>
+ * This interface represents an optimization algorithm for
+ * {@link DifferentiableMultivariateRealFunction scalar differentiable objective
+ * functions}.
+ * Optimization algorithms find the input point set that either {@link GoalType
+ * maximize or minimize} an objective function.
+ *
  * @see MultivariateRealOptimizer
  * @see DifferentiableMultivariateVectorialOptimizer
  * @version $Revision$ $Date$
@@ -35,8 +37,8 @@ public interface DifferentiableMultivariateRealOptimizer
     /**
      * Get the number of evaluations of the objective function gradient.
      * The number of evaluations corresponds to the last call to the
-     * {@link #optimize(DifferentiableMultivariateRealFunction, GoalType, double[]) optimize}
-     * method. It is 0 if the method has not been called yet.
+     * {@code optimize} method (see {@link BaseMultivariateRealOptimizer}).
+     * It is 0 if the method has not been called yet.
      *
      * @return the number of evaluations of the objective function gradient.
      */
diff --git a/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarDifferentiableOptimizer.java b/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarDifferentiableOptimizer.java
index 2094ec0be..07d57df08 100644
--- a/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarDifferentiableOptimizer.java
+++ b/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarDifferentiableOptimizer.java
@@ -70,7 +70,7 @@ public abstract class AbstractScalarDifferentiableOptimizer
      */
     protected AbstractScalarDifferentiableOptimizer() {}
     /**
-     * @param convergenceChecker Convergence checker.
+     * @param checker Convergence checker.
      * @param maxIterations Maximum number of iterations.
      * @param maxEvaluations Maximum number of evaluations.
      */
diff --git a/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarOptimizer.java b/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarOptimizer.java
index d4e2a122a..7b3b827ab 100644
--- a/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarOptimizer.java
+++ b/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarOptimizer.java
@@ -48,7 +48,7 @@ public abstract class AbstractScalarOptimizer
      */
     protected AbstractScalarOptimizer() {}
     /**
-     * @param convergenceChecker Convergence checker.
+     * @param checker Convergence checker.
      * @param maxIterations Maximum number of iterations.
      * @param maxEvaluations Maximum number of evaluations.
      */
diff --git a/src/main/java/org/apache/commons/math/optimization/general/BaseAbstractScalarOptimizer.java b/src/main/java/org/apache/commons/math/optimization/general/BaseAbstractScalarOptimizer.java
index 89927c111..89d72c4e6 100644
--- a/src/main/java/org/apache/commons/math/optimization/general/BaseAbstractScalarOptimizer.java
+++ b/src/main/java/org/apache/commons/math/optimization/general/BaseAbstractScalarOptimizer.java
@@ -78,7 +78,7 @@ public abstract class BaseAbstractScalarOptimizer<T extends MultivariateRealFunc
              DEFAULT_MAX_EVALUATIONS);
     }
     /**
-     * @param convergenceChecker Convergence checker.
+     * @param checker Convergence checker.
      * @param maxIterations Maximum number of iterations.
      * @param maxEvaluations Maximum number of evaluations.
      */