svn commit: r1244375 - in /commons/proper/math/trunk/src: main/java/org/apache/commons/math3/distribution/ main/java/org/apache/commons/math3/transform/ test/java/org/apache/commons/math3/transform/

[ce...@apache.org]

Author: celestin
Date: Wed Feb 15 06:30:05 2012
New Revision: 1244375

URL: http://svn.apache.org/viewvc?rev=1244375&view=rev
Log:
Fixed Javadoc warnings.

Modified:
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/PoissonDistribution.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/transform/FastFourierTransformer.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/transform/FastSineTransformer.java
    commons/proper/math/trunk/src/test/java/org/apache/commons/math3/transform/RealTransformerAbstractTest.java

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/PoissonDistribution.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/PoissonDistribution.java?rev=1244375&r1=1244374&r2=1244375&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/PoissonDistribution.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/distribution/PoissonDistribution.java Wed Feb 15 06:30:05 2012
@@ -208,8 +208,7 @@ public class PoissonDistribution extends
      *
      * The upper bound of the support is positive infinity,
      * regardless of the parameter values. There is no integer infinity,
-     * so this method returns {@code Integer.MAX_VALUE} and
-     * {@link #isSupportUpperBoundInclusive()} returns {@code true}.
+     * so this method returns {@code Integer.MAX_VALUE}.
      *
      * @return upper bound of the support (always {@code Integer.MAX_VALUE} for
      * positive infinity)

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/transform/FastFourierTransformer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/transform/FastFourierTransformer.java?rev=1244375&r1=1244374&r2=1244375&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/transform/FastFourierTransformer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/transform/FastFourierTransformer.java Wed Feb 15 06:30:05 2012
@@ -432,8 +432,8 @@ public class FastFourierTransformer impl
 
     /**
      * Performs a multi-dimensional Fourier transform on a given array. Use
-     * {@link #transform(Complex[])} and {@link #inverseTransform(Complex[])} in
-     * a row-column implementation in any number of dimensions with
+     * {@link #transform(Complex[], TransformType)} in a row-column
+     * implementation in any number of dimensions with
      * O(N×log(N)) complexity with
      * N = n<sub>1</sub> &times; n<sub>2</sub> &times;n<sub>3</sub> &times; ...
      * &times; n<sub>d</sub>, where n<sub>k</sub> is the number of elements in

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/transform/FastSineTransformer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/transform/FastSineTransformer.java?rev=1244375&r1=1244374&r2=1244375&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/transform/FastSineTransformer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/transform/FastSineTransformer.java Wed Feb 15 06:30:05 2012
@@ -67,9 +67,8 @@ import org.apache.commons.math3.util.Fas
  * transform requires the length of the data to be a power of two. Besides,
  * it implicitly assumes that the sampled function is odd. In particular, the
  * first element of the data set must be 0, which is enforced in
- * {@link #transform(UnivariateFunction, double, double, int)} and
- * {@link #inverseTransform(UnivariateFunction, double, double, int)}, after
- * sampling.
+ * {@link #transform(UnivariateFunction, double, double, int, TransformType)},
+ * after sampling.
  * </p>
  *
  * @version $Id$

Modified: commons/proper/math/trunk/src/test/java/org/apache/commons/math3/transform/RealTransformerAbstractTest.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/test/java/org/apache/commons/math3/transform/RealTransformerAbstractTest.java?rev=1244375&r1=1244374&r2=1244375&view=diff
==============================================================================
--- commons/proper/math/trunk/src/test/java/org/apache/commons/math3/transform/RealTransformerAbstractTest.java (original)
+++ commons/proper/math/trunk/src/test/java/org/apache/commons/math3/transform/RealTransformerAbstractTest.java Wed Feb 15 06:30:05 2012
@@ -31,9 +31,9 @@ import org.junit.Test;
  * This abstract test handles the automatic generation of random data of various
  * sizes. For each generated data array, actual values (returned by the
  * transformer to be tested) are compared to expected values, returned by the
- * {@link #transform(double[], boolean)} (to be implemented by the user: a naive
- * method may be used). Methods are also provided to test that invalid parameters
- * throw the expected exceptions.
+ * {@link #transform(double[], TransformType)} (to be implemented by the user:
+ * a naive method may be used). Methods are also provided to test that invalid
+ * parameters throw the expected exceptions.
  *
  * @since 3.0
  * @version $Id$
@@ -147,7 +147,7 @@ public abstract class RealTransformerAbs
      */
 
     /**
-     * {@link RealTransformer#transform(double[], TransformType))} should throw a
+     * {@link RealTransformer#transform(double[], TransformType)} should throw a
      * {@link MathIllegalArgumentException} if data size is invalid.
      */
     @Test
@@ -247,14 +247,14 @@ public abstract class RealTransformerAbs
      */
 
     /**
-     * Accuracy check of {@link RealTransformer#transform(double[])}. For each
-     * valid data size returned by
+     * Accuracy check of {@link RealTransformer#transform(double[], TransformType)}.
+     * For each valid data size returned by
      * {@link #getValidDataSize(int) getValidDataSize(i)},
      * a random data array is generated with
      * {@link #createRealData(int) createRealData(i)}. The actual
      * transform is computed and compared to the expected transform, return by
-     * {@link #transform(double[], boolean)}. Actual and expected values should
-     * be equal to within the relative error returned by
+     * {@link #transform(double[], TransformType)}. Actual and expected values
+     * should be equal to within the relative error returned by
      * {@link #getRelativeTolerance(int) getRelativeTolerance(i)}.
      */
     @Test
@@ -271,14 +271,14 @@ public abstract class RealTransformerAbs
 
     /**
      * Accuracy check of
-     * {@link RealTransformer#transform(UnivariateFunction, double, double, int)}.
+     * {@link RealTransformer#transform(UnivariateFunction, double, double, int, TransformType)}.
      * For each valid data size returned by
      * {@link #getValidDataSize(int) getValidDataSize(i)},
      * the {@link UnivariateFunction} returned by {@link #getValidFunction()} is
      * sampled. The actual transform is computed and compared to the expected
-     * transform, return by {@link #transform(double[], boolean)}. Actual and
-     * expected values should be equal to within the relative error returned by
-     * {@link #getRelativeTolerance(int) getRelativeTolerance(i)}.
+     * transform, return by {@link #transform(double[], TransformType)}. Actual
+     * and expected values should be equal to within the relative error returned
+     * by {@link #getRelativeTolerance(int) getRelativeTolerance(i)}.
      */
     @Test
     public void testTransformFunction() {