Thank you Andreou, patches applied. Tim
On Wed, 2003-06-11 at 09:26, Andreou Andreas wrote: > Hi, > according to the site > " Javadoc generation currently throws 35 warnings. Bring the Javadoc > into compliance (i.e. reach zero warnings)" > > I've made some javadoc fixes to the following files: > src/java/org/apache/commons/math/ContractableDoubleArray.java > src/java/org/apache/commons/math/EmpiricalDistribution.java > src/java/org/apache/commons/math/ExpandableDoubleArray.java > src/java/org/apache/commons/math/FixedDoubleArray.java > src/java/org/apache/commons/math/RandomDataImpl.java > src/java/org/apache/commons/math/RealMatrix.java > src/java/org/apache/commons/math/RealMatrixImpl.java > src/java/org/apache/commons/math/stat/AbstractStoreUnivariate.java > src/java/org/apache/commons/math/stat/distribution/FDistributionImpl.java > > and attached are the u-diffs... > Respect, > andreas andreou > ---- > > Index: ./src/java/org/apache/commons/math/stat/distribution/FDistributionImpl.java > =================================================================== > RCS file: > /home/cvspublic/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/stat/distribution/FDistributionImpl.java,v > retrieving revision 1.1 > diff -u -r1.1 FDistributionImpl.java > --- ./src/java/org/apache/commons/math/stat/distribution/FDistributionImpl.java > 11 Jun 2003 01:19:19 -0000 1.1 > +++ ./src/java/org/apache/commons/math/stat/distribution/FDistributionImpl.java > 11 Jun 2003 14:13:25 -0000 > @@ -73,7 +73,8 @@ > > /** > * Create a F distribution using the given degrees of freedom. > - * @param degreesOfFreedom the degrees of freedom. > + * @param numeratorDegreesOfFreedom the degrees of freedom. > + * @param denominatorDegreesOfFreedom > */ > public FDistributionImpl(double numeratorDegreesOfFreedom, > double denominatorDegreesOfFreedom){ > > > Index: ./src/java/org/apache/commons/math/stat/AbstractStoreUnivariate.java > =================================================================== > RCS file: > /home/cvspublic/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/stat/AbstractStoreUnivariate.java,v > retrieving revision 1.2 > diff -u -r1.2 AbstractStoreUnivariate.java > --- ./src/java/org/apache/commons/math/stat/AbstractStoreUnivariate.java 4 Jun > 2003 02:22:48 -0000 1.2 > +++ ./src/java/org/apache/commons/math/stat/AbstractStoreUnivariate.java 11 Jun > 2003 14:14:52 -0000 > @@ -64,7 +64,7 @@ > > /** > * Returns the most frequently occuring value > - * @see org.apache.commons.math.StoreUnivariate#getMode() > + * @see org.apache.commons.math.stat.StoreUnivariate#getMode() > */ > public double getMode() { > // Mode depends on a refactor Freq class > @@ -74,7 +74,7 @@ > > /** > * Returns the skewness of this collection of values > - * @see org.apache.commons.math.StoreUnivariate#getSkewness() > + * @see org.apache.commons.math.stat.StoreUnivariate#getSkewness() > */ > public double getSkewness() { > // Initialize the skewness > @@ -102,7 +102,7 @@ > > /** > * Returns the kurtosis for this collection of values > - * @see org.apache.commons.math.StoreUnivariate#getKurtosis() > + * @see org.apache.commons.math.stat.StoreUnivariate#getKurtosis() > */ > public double getKurtosis() { > // Initialize the kurtosis > @@ -134,7 +134,7 @@ > /** > * Returns the type or class of kurtosis that this collection of > * values exhibits > - * @see org.apache.commons.math.StoreUnivariate#getKurtosisClass() > + * @see org.apache.commons.math.stat.StoreUnivariate#getKurtosisClass() > */ > public int getKurtosisClass() { > > @@ -153,7 +153,7 @@ > > /** > * Returns the mean for this collection of values > - * @see org.apache.commons.math.Univariate#getMean() > + * @see org.apache.commons.math.stat.Univariate#getMean() > */ > public double getMean() { > double arithMean = getSum() / getN(); > @@ -162,7 +162,7 @@ > > /** > * Returns the geometric mean for this collection of values > - * @see org.apache.commons.math.Univariate#getGeometricMean() > + * @see org.apache.commons.math.stat.Univariate#getGeometricMean() > */ > public double getGeometricMean() { > double gMean = Math.pow(getProduct(),(1.0/getN())); > @@ -171,7 +171,7 @@ > > /** > * Returns the product for this collection of values > - * @see org.apache.commons.math.Univariate#getProduct() > + * @see org.apache.commons.math.stat.Univariate#getProduct() > */ > public double getProduct() { > double product = Double.NaN; > @@ -187,7 +187,7 @@ > > /** > * Returns the variance for this collection of values > - * @see org.apache.commons.math.Univariate#getVariance() > + * @see org.apache.commons.math.stat.Univariate#getVariance() > */ > public double getVariance() { > // Initialize variance > @@ -216,7 +216,7 @@ > > /** > * Returns the standard deviation for this collection of values > - * @see org.apache.commons.math.Univariate#getStandardDeviation() > + * @see org.apache.commons.math.stat.Univariate#getStandardDeviation() > */ > public double getStandardDeviation() { > double stdDev = Double.NaN; > @@ -228,7 +228,7 @@ > > /** > * Returns the maximum value contained herein. > - * @see org.apache.commons.math.Univariate#getMax() > + * @see org.apache.commons.math.stat.Univariate#getMax() > */ > public double getMax() { > > @@ -250,7 +250,7 @@ > > /** > * Returns the minimum value contained herein > - * @see org.apache.commons.math.Univariate#getMin() > + * @see org.apache.commons.math.stat.Univariate#getMin() > */ > public double getMin() { > // Initialize minimum to NaN > @@ -271,7 +271,7 @@ > > /** > * Returns the sum of all values contained herein > - * @see org.apache.commons.math.Univariate#getSum() > + * @see org.apache.commons.math.stat.Univariate#getSum() > */ > public double getSum() { > double accum = 0.0; > @@ -283,7 +283,7 @@ > > /** > * Returns the sun of the squares of all values contained herein > - * @see org.apache.commons.math.Univariate#getSumsq() > + * @see org.apache.commons.math.stat.Univariate#getSumsq() > */ > public double getSumsq() { > double accum = 0.0; > @@ -296,7 +296,7 @@ > /** > * Uses <a href="http://www.nist.gov/dads/HTML/shellsort.html">Shell sort > * </a> > - * @see org.apache.commons.math.StoreUnivariate#getSortedValues() > + * @see org.apache.commons.math.stat.StoreUnivariate#getSortedValues() > * > */ > public double[] getSortedValues() { > @@ -324,7 +324,7 @@ > > /** > * Returns an estimate for the pth percentile of the stored values > - * @see org.apache.commons.math.StoreUnivariate#getPercentile() > + * @see org.apache.commons.math.stat.StoreUnivariate#getPercentile(double) > */ > public double getPercentile(double p) { > if ((p > 100) || (p <= 0)) { > > > Index: ./src/java/org/apache/commons/math/ContractableDoubleArray.java > =================================================================== > RCS file: > /home/cvspublic/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/ContractableDoubleArray.java,v > retrieving revision 1.5 > diff -u -r1.5 ContractableDoubleArray.java > --- ./src/java/org/apache/commons/math/ContractableDoubleArray.java 21 May 2003 > 06:46:26 -0000 1.5 > +++ ./src/java/org/apache/commons/math/ContractableDoubleArray.java 11 Jun 2003 > 14:16:04 -0000 > @@ -170,7 +170,7 @@ > /** > * Adds an element to the end of this expandable array > * > - * @return value to be added to end of array > + * @param value to be added to end of array > */ > public synchronized void addElement(double value) { > super.addElement(value); > @@ -266,7 +266,7 @@ > /** > * Sets the contraction criteria for this ExpandContractDoubleArray. > * > - * @param new contraction criteria > + * @param contractionCriteria contraction criteria > */ > public void setContractionCriteria(float contractionCriteria) { > checkContractExpand(contractionCriteria, getExpansionFactor()); > @@ -280,7 +280,7 @@ > * expansionCriteria > * > * @param expansionFactor > - * @param contractionCriteria > + * @param contractionCritera > */ > protected void checkContractExpand(float contractionCritera, > float expansionFactor) { > > > Index: ./src/java/org/apache/commons/math/EmpiricalDistribution.java > =================================================================== > RCS file: > /home/cvspublic/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/EmpiricalDistribution.java,v > retrieving revision 1.3 > diff -u -r1.3 EmpiricalDistribution.java > --- ./src/java/org/apache/commons/math/EmpiricalDistribution.java 6 Jun 2003 > 03:38:03 -0000 1.3 > +++ ./src/java/org/apache/commons/math/EmpiricalDistribution.java 11 Jun 2003 > 14:16:46 -0000 > @@ -94,7 +94,7 @@ > > /** > * Computes the empirical distribution from the input file > - * @param URL url of the input file > + * @param file url of the input file > * @throws IOException if an IO error occurs > */ > void load(File file) throws IOException; > @@ -135,7 +135,7 @@ > * Saves distribution to a file. Overwrites the file if it exists. > * <strong>Preconditions:</strong><ul> > * <li>the distribution must be loaded before invoking this method</li></ul> > - * @param fully qualified file path for the file to be written > + * @param filePath fully qualified file path for the file to be written > * @throws IOException if an error occurs reading the file > * @throws IllegalStateException if the distribution has not been loaded > */ > > > Index: ./src/java/org/apache/commons/math/ExpandableDoubleArray.java > =================================================================== > RCS file: > /home/cvspublic/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/ExpandableDoubleArray.java,v > retrieving revision 1.10 > diff -u -r1.10 ExpandableDoubleArray.java > --- ./src/java/org/apache/commons/math/ExpandableDoubleArray.java 21 May 2003 > 06:24:30 -0000 1.10 > +++ ./src/java/org/apache/commons/math/ExpandableDoubleArray.java 11 Jun 2003 > 14:17:44 -0000 > @@ -223,7 +223,7 @@ > * array class. Note that this function will also expand the internal > * array as needed. > * > - * @param a new number of elements > + * @param i a new number of elements > */ > public synchronized void setNumElements(int i) { > > @@ -321,7 +321,7 @@ > /** > * Adds an element to the end of this expandable array > * > - * @return value to be added to end of array > + * @param value value to be added to end of array > */ > public synchronized void addElement(double value) { > numElements++; > > > Index: ./src/java/org/apache/commons/math/FixedDoubleArray.java > =================================================================== > RCS file: > /home/cvspublic/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/FixedDoubleArray.java,v > retrieving revision 1.3 > diff -u -r1.3 FixedDoubleArray.java > --- ./src/java/org/apache/commons/math/FixedDoubleArray.java 21 May 2003 05:48:25 > -0000 1.3 > +++ ./src/java/org/apache/commons/math/FixedDoubleArray.java 11 Jun 2003 14:18:20 > -0000 > @@ -312,7 +312,7 @@ > * make little sense to allow people to "drop" objects from the > * "front". > * > - * @param number of elements to discard. > + * @param i number of elements to discard. > * > * @see org.apache.commons.math.DoubleArray#discardFrontElements(int) > */ > > > Index: ./src/java/org/apache/commons/math/RandomDataImpl.java > =================================================================== > RCS file: > /home/cvspublic/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/RandomDataImpl.java,v > retrieving revision 1.4 > diff -u -r1.4 RandomDataImpl.java > --- ./src/java/org/apache/commons/math/RandomDataImpl.java 5 Jun 2003 18:35:24 > -0000 1.4 > +++ ./src/java/org/apache/commons/math/RandomDataImpl.java 11 Jun 2003 14:19:24 > -0000 > @@ -501,7 +501,7 @@ > * shuffle to randomly re-order the last <code>end</code> elements of list. > * > * @param list list to be shuffled > - * @end element past which shuffling begins > + * @param end element past which shuffling begins > */ > private void shuffle(int[] list, int end) { > int target = 0; > > > Index: ./src/java/org/apache/commons/math/RealMatrix.java > =================================================================== > RCS file: > /home/cvspublic/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/RealMatrix.java,v > retrieving revision 1.2 > diff -u -r1.2 RealMatrix.java > --- ./src/java/org/apache/commons/math/RealMatrix.java 13 May 2003 19:08:14 > -0000 1.2 > +++ ./src/java/org/apache/commons/math/RealMatrix.java 11 Jun 2003 14:20:22 > -0000 > @@ -116,7 +116,7 @@ > > /** > * Sets/overwrites the underlying data for the matrix > - * @param 2-dimensional array of entries > + * @param data 2-dimensional array of entries > */ > public void setData(double[][] data); > > @@ -145,7 +145,7 @@ > /** > * Returns the entry in the specified row and column > * @param row row location of entry to be fetched > - * @param col column location of entry to be fetched > + * @param column column location of entry to be fetched > * @return matrix entry in row,column > * @throws IllegalArgumentException if entry does not exist > */ > @@ -154,7 +154,7 @@ > /** > * Sets the entry in the specified row and column to the specified value > * @param row row location of entry to be set > - * @param col column location of entry to be set > + * @param column column location of entry to be set > * @param value value to set > * @throws IllegalArgumentException if entry does not exist > */ > @@ -175,7 +175,7 @@ > > /** > * Returns the determinant of this matrix > - * @returns determinant > + * @return determinant > */ > public double getDeterminant(); > > > Index: ./src/java/org/apache/commons/math/RealMatrixImpl.java > =================================================================== > RCS file: > /home/cvspublic/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/RealMatrixImpl.java,v > retrieving revision 1.2 > diff -u -r1.2 RealMatrixImpl.java > --- ./src/java/org/apache/commons/math/RealMatrixImpl.java 13 May 2003 19:08:14 > -0000 1.2 > +++ ./src/java/org/apache/commons/math/RealMatrixImpl.java 11 Jun 2003 14:21:05 > -0000 > @@ -72,7 +72,6 @@ > * Create a new RealMatrix with the supplied row and column dimensions > * @param rowDimension the number of rows in the new matrix > * @param columnDimension the number of columns in the new matrix > - * @return newly created matrix > */ > public RealMatrixImpl(int rowDimension, > int columnDimension) { > @@ -218,7 +217,7 @@ > > /** > * Sets/overwrites the underlying data for the matrix > - * @param 2-dimensional array of entries > + * @param data 2-dimensional array of entries > */ > public void setData(double[][] data) { > this.data = data; > @@ -263,7 +262,7 @@ > /** > * Returns the entry in the specified row and column > * @param row row location of entry to be fetched > - * @param col column location of entry to be fetched > + * @param column column location of entry to be fetched > * @return matrix entry in row,column > * @throws IllegalArgumentException if entry does not exist > */ > @@ -279,7 +278,7 @@ > /** > * Sets the entry in the specified row and column to the specified value > * @param row row location of entry to be set > - * @param col column location of entry to be set > + * @param column column location of entry to be set > * @param value value to set > * @throws IllegalArgumentException if entry does not exist > */ > > ---- > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]