From 84e3a4787c87a62351a68fa2dc6b1b624ccd20ab Mon Sep 17 00:00:00 2001
From: Sebastian Bazley <sebb@apache.org>
Date: Fri, 1 Oct 2010 01:55:28 +0000
Subject: [PATCH] Javadoc fixes

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1003352 13f79535-47bb-0310-9956-ffa450edef68
---
 .../BaseMultiStartMultivariateRealOptimizer.java       | 10 +++++-----
 .../BaseMultiStartMultivariateVectorialOptimizer.java  | 10 +++++-----
 .../univariate/MultiStartUnivariateRealOptimizer.java  | 10 +++++-----
 .../commons/math/util/MultidimensionalCounter.java     |  2 +-
 4 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateRealOptimizer.java b/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateRealOptimizer.java
index e082b9349..51ec531c8 100644
--- a/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateRealOptimizer.java
+++ b/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateRealOptimizer.java
@@ -74,13 +74,13 @@ public class BaseMultiStartMultivariateRealOptimizer<FUNC extends MultivariateRe
 
     /**
      * Get all the optima found during the last call to {@link
-     * #optimize(FUNC,GoalType,double[]) optimize}.
+     * #optimize(MultivariateRealFunction,GoalType,double[]) optimize}.
      * The optimizer stores all the optima found during a set of
-     * restarts. The {@link #optimize(FUNC,GoalType,double[])
+     * restarts. The {@link #optimize(MultivariateRealFunction,GoalType,double[])
      * optimize} method returns the best point only. This method
      * returns all the points found at the end of each starts,
      * including the best one already returned by the {@link
-     * #optimize(FUNC,GoalType,double[]) optimize} method.
+     * #optimize(MultivariateRealFunction,GoalType,double[]) optimize} method.
      * <br/>
      * The returned array as one element for each start as specified
      * in the constructor. It is ordered with the results from the
@@ -88,14 +88,14 @@ public class BaseMultiStartMultivariateRealOptimizer<FUNC extends MultivariateRe
      * objective value (i.e in ascending order if minimizing and in
      * descending order if maximizing), followed by and null elements
      * corresponding to the runs that did not converge. This means all
-     * elements will be null if the {@link #optimize(FUNC,GoalType,double[])
+     * elements will be null if the {@link #optimize(MultivariateRealFunction,GoalType,double[])
      * optimize} method did throw a {@link ConvergenceException}).
      * This also means that if the first element is not {@code null}, it
      * is the best point found across all starts.
      *
      * @return an array containing the optima.
      * @throws MathIllegalStateException if {@link
-     * #optimize(FUNC,GoalType,double[]) optimize} has not been called.
+     * #optimize(MultivariateRealFunction,GoalType,double[]) optimize} has not been called.
      */
     public RealPointValuePair[] getOptima() {
         if (optima == null) {
diff --git a/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateVectorialOptimizer.java b/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateVectorialOptimizer.java
index 00a4196e6..6a9b23e23 100644
--- a/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateVectorialOptimizer.java
+++ b/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateVectorialOptimizer.java
@@ -73,13 +73,13 @@ public class BaseMultiStartMultivariateVectorialOptimizer<FUNC extends Multivari
 
     /**
      * Get all the optima found during the last call to {@link
-     * #optimize(FUNC,double[],double[],double[]) optimize}.
+     * #optimize(MultivariateVectorialFunction,double[],double[],double[]) optimize}.
      * The optimizer stores all the optima found during a set of
-     * restarts. The {@link #optimize(FUNC,double[],double[],double[])
+     * restarts. The {@link #optimize(MultivariateVectorialFunction,double[],double[],double[])
      * optimize} method returns the best point only. This method
      * returns all the points found at the end of each starts, including
      * the best one already returned by the {@link
-     * #optimize(FUNC,double[],double[],double[]) optimize} method.
+     * #optimize(MultivariateVectorialFunction,double[],double[],double[]) optimize} method.
      * <br/>
      * The returned array as one element for each start as specified
      * in the constructor. It is ordered with the results from the
@@ -88,14 +88,14 @@ public class BaseMultiStartMultivariateVectorialOptimizer<FUNC extends Multivari
      * descending order if maximizing), followed by and null elements
      * corresponding to the runs that did not converge. This means all
      * elements will be null if the {@link
-     * #optimize(FUNC,double[],double[],double[]) optimize} method did
+     * #optimize(MultivariateVectorialFunction,double[],double[],double[]) optimize} method did
      * throw a {@link ConvergenceException}). This also means that if
      * the first element is not {@code null}, it is the best point found
      * across all starts.
      *
      * @return array containing the optima
      * @throws MathIllegalStateException if {@link
-     * #optimize(FUNC,double[],double[],double[]) optimize} has not been
+     * #optimize(MultivariateVectorialFunction,double[],double[],double[]) optimize} has not been
      * called.
      */
     public VectorialPointValuePair[] getOptima() {
diff --git a/src/main/java/org/apache/commons/math/optimization/univariate/MultiStartUnivariateRealOptimizer.java b/src/main/java/org/apache/commons/math/optimization/univariate/MultiStartUnivariateRealOptimizer.java
index 322968536..2820c2568 100644
--- a/src/main/java/org/apache/commons/math/optimization/univariate/MultiStartUnivariateRealOptimizer.java
+++ b/src/main/java/org/apache/commons/math/optimization/univariate/MultiStartUnivariateRealOptimizer.java
@@ -106,12 +106,12 @@ public class MultiStartUnivariateRealOptimizer<FUNC extends UnivariateRealFuncti
 
     /**
      * Get all the optima found during the last call to {@link
-     * #optimize(FUNC,GoalType,double,double) optimize}.
+     * #optimize(UnivariateRealFunction,GoalType,double,double) optimize}.
      * The optimizer stores all the optima found during a set of
-     * restarts. The {@link #optimize(FUNC,GoalType,double,double) optimize}
+     * restarts. The {@link #optimize(UnivariateRealFunction,GoalType,double,double) optimize}
      * method returns the best point only. This method returns all the points
      * found at the end of each starts, including the best one already
-     * returned by the {@link #optimize(FUNC,GoalType,double,double) optimize}
+     * returned by the {@link #optimize(UnivariateRealFunction,GoalType,double,double) optimize}
      * method.
      * <br/>
      * The returned array as one element for each start as specified
@@ -121,14 +121,14 @@ public class MultiStartUnivariateRealOptimizer<FUNC extends UnivariateRealFuncti
      * descending order if maximizing), followed by {@code null} elements
      * corresponding to the runs that did not converge. This means all
      * elements will be {@code null} if the {@link
-     * #optimize(FUNC,GoalType,double,double) optimize} method did throw a
+     * #optimize(UnivariateRealFunction,GoalType,double,double) optimize} method did throw a
      * {@link ConvergenceException}). This also means that if the first
      * element is not {@code null}, it is the best point found across all
      * starts.
      *
      * @return an array containing the optima.
      * @throws MathIllegalStateException if {@link
-     * #optimize(FUNC,GoalType,double,double) optimize} has not been called.
+     * #optimize(UnivariateRealFunction,GoalType,double,double) optimize} has not been called.
      */
     public UnivariateRealPointValuePair[] getOptima() {
         if (optima == null) {
diff --git a/src/main/java/org/apache/commons/math/util/MultidimensionalCounter.java b/src/main/java/org/apache/commons/math/util/MultidimensionalCounter.java
index 28f673b27..ff887902c 100644
--- a/src/main/java/org/apache/commons/math/util/MultidimensionalCounter.java
+++ b/src/main/java/org/apache/commons/math/util/MultidimensionalCounter.java
@@ -148,7 +148,7 @@ public class MultidimensionalCounter implements Iterable<Integer> {
         }
 
         /**
-         * @throws UnsupportedOperationException.
+         * @throws UnsupportedOperationException
          */
         public void remove() {
             throw new UnsupportedOperationException();