Revision: 7306 Author: j...@google.com Date: Sun Dec 13 21:28:30 2009 Log: Javadoc cleanups.
http://code.google.com/p/google-web-toolkit/source/detail?r=7306 Modified: /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/lang/Float.java /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/BitLevel.java /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/Division.java /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/Elementary.java /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/Logical.java /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/RoundingMode.java /changes/jat/bigdecimal/user/test/com/google/gwt/emultest/java/math/BigDecimalArithmeticTest.java /changes/jat/bigdecimal/user/test/com/google/gwt/emultest/java/math/BigDecimalConstructorsTest.java /changes/jat/bigdecimal/user/test/com/google/gwt/emultest/java/math/BigDecimalConvertTest.java ======================================= --- /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/lang/Float.java Fri Dec 11 22:46:18 2009 +++ /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/lang/Float.java Sun Dec 13 21:28:30 2009 @@ -16,7 +16,7 @@ package java.lang; /** - * Wraps a primitve <code>float</code> as an object. + * Wraps a primitive <code>float</code> as an object. */ public final class Float extends Number implements Comparable<Float> { public static final float MAX_VALUE = 3.4028235e+38f; @@ -40,7 +40,9 @@ } /** - * @skip Here for shared implementation with Arrays.hashCode + * @skip Here for shared implementation with Arrays.hashCode. + * @param f + * @return hash value of float (currently just truncated to int) */ public static int hashCode(float f) { return (int) f; ======================================= --- /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/BitLevel.java Fri Dec 11 13:21:45 2009 +++ /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/BitLevel.java Sun Dec 13 21:28:30 2009 @@ -100,9 +100,8 @@ * Performs a flipBit on the BigInteger, returning a BigInteger with the the * specified bit flipped. * - * @param intCount: the index of the element of the digits array where the - * operation will be performed - * @param bitNumber: the bit's position in the intCount element + * @param val BigInteger to operate on + * @param n the bit to flip */ static BigInteger flipBit(BigInteger val, int n) { int resSign = (val.sign == 0) ? 1 : val.sign; ======================================= --- /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/Division.java Fri Dec 11 13:21:45 2009 +++ /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/Division.java Sun Dec 13 21:28:30 2009 @@ -342,8 +342,8 @@ /** * Performs the final reduction of the Montgomery algorithm. * - * @see monPro(BigInteger, BigInteger, BigInteger, long) - * @see monSquare(BigInteger, BigInteger, long) + * @see #monPro(BigInteger, BigInteger, BigInteger, long) + * @see #monSquare(BigInteger, BigInteger, long) */ static BigInteger finalSubtraction(int res[], BigInteger modulus) { ======================================= --- /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/Elementary.java Fri Dec 11 13:21:45 2009 +++ /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/Elementary.java Sun Dec 13 21:28:30 2009 @@ -42,7 +42,7 @@ class Elementary { /** - * @see BigInteger#add(BigInteger). + * @see BigInteger#add(BigInteger) . * @param op1 * @param op2 * @return @@ -251,7 +251,7 @@ } /** - * @see BigInteger#subtract(BigInteger). + * @see BigInteger#subtract(BigInteger) . * @param op1 * @param op2 * @return ======================================= --- /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/Logical.java Fri Dec 11 13:21:45 2009 +++ /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/Logical.java Sun Dec 13 21:28:30 2009 @@ -40,7 +40,7 @@ class Logical { /** - * @see BigInteger#and(BigInteger). + * @see BigInteger#and(BigInteger) * @param val * @param that * @return @@ -181,7 +181,7 @@ } /** - * @see BigInteger#andNot(BigInteger). + * @see BigInteger#andNot(BigInteger) * @param val * @param that * @return @@ -456,7 +456,7 @@ } /** - * @see BigInteger#not(). + * @see BigInteger#not() * @param val * @return */ @@ -503,7 +503,7 @@ return new BigInteger(-val.sign, i, resDigits); } - /*...@see BigInteger#or(BigInteger). + /*...@see BigInteger#or(BigInteger) * @param val * @param that * @return @@ -674,7 +674,7 @@ } /** - * @see BigInteger#xor(BigInteger). + * @see BigInteger#xor(BigInteger) * @param val * @param that * @return ======================================= --- /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/RoundingMode.java Fri Dec 11 13:21:45 2009 +++ /changes/jat/bigdecimal/user/super/com/google/gwt/emul/java/math/RoundingMode.java Sun Dec 13 21:28:30 2009 @@ -120,17 +120,12 @@ throw new IllegalArgumentException("Invalid rounding mode"); //$NON-NLS-1$ } } - - /** - * The old constant of <code>BigDecimal</code>. - */ - private final int bigDecimalRM; /** * Set the old constant. - * @param rm + * @param rm unused */ RoundingMode(int rm) { - bigDecimalRM = rm; + // Note that we do not need the old-style rounding mode, so we ignore it. } } ======================================= --- /changes/jat/bigdecimal/user/test/com/google/gwt/emultest/java/math/BigDecimalArithmeticTest.java Fri Dec 11 13:21:45 2009 +++ /changes/jat/bigdecimal/user/test/com/google/gwt/emultest/java/math/BigDecimalArithmeticTest.java Sun Dec 13 21:28:30 2009 @@ -694,8 +694,7 @@ BigDecimal arg1 = new BigDecimal("320.0E+2147483647"); BigDecimal arg2 = new BigDecimal("6E-2147483647"); try { - BigDecimal result = arg1.divide(arg2, Integer.MAX_VALUE, - java.math.RoundingMode.CEILING); + arg1.divide(arg2, Integer.MAX_VALUE, RoundingMode.CEILING); fail("Expected ArithmeticException when dividing with a scale that's too large"); } catch (ArithmeticException e) { // expected behaviour ======================================= --- /changes/jat/bigdecimal/user/test/com/google/gwt/emultest/java/math/BigDecimalConstructorsTest.java Sun Dec 13 11:42:16 2009 +++ /changes/jat/bigdecimal/user/test/com/google/gwt/emultest/java/math/BigDecimalConstructorsTest.java Sun Dec 13 21:28:30 2009 @@ -358,7 +358,7 @@ } /** - * new BigDecimal(int, MathContext) + * new BigDecimal(int, MathContext). */ public void testConstrIntMathContext() { int a = 732546982; @@ -373,7 +373,7 @@ } /** - * new BigDecimal(long value) + * new BigDecimal(long value). */ public void testConstrLong() { long a = 4576578677732546982L; @@ -385,7 +385,7 @@ } /** - * new BigDecimal(long, MathContext) + * new BigDecimal(long, MathContext). */ public void testConstrLongMathContext() { long a = 4576578677732546982L; @@ -610,7 +610,7 @@ /** * new BigDecimal(String value); value contains both exponent and decimal - * point + * point. */ public void testConstrStringWithExponentWithPoint4() { String a = "23809648392384754573567356745735635678.90295784902768787678287E+21"; ======================================= --- /changes/jat/bigdecimal/user/test/com/google/gwt/emultest/java/math/BigDecimalConvertTest.java Fri Dec 11 13:21:45 2009 +++ /changes/jat/bigdecimal/user/test/com/google/gwt/emultest/java/math/BigDecimalConvertTest.java Sun Dec 13 21:28:30 2009 @@ -70,7 +70,7 @@ } /** - * Double value of a large negative BigDecimal + * Double value of a large negative BigDecimal. */ public void testDoubleValueNegInfinity() { String a = "-123809648392384754573567356745735.63567890295784902768787678287E+400"; @@ -80,7 +80,7 @@ } /** - * Double value of a small positive BigDecimal + * Double value of a small positive BigDecimal. */ // TODO(jat): add back after Double.doubleToLongBits is implemented // public void testDoubleValuePlusZero() { @@ -198,7 +198,7 @@ } /** - * Long value of a negative BigDecimal + * Long value of a negative BigDecimal. */ public void testLongValueNeg() { String a = "-123809648392384754573567356745735.63567890295784902768787678287E+21"; @@ -208,7 +208,7 @@ } /** - * Long value of a positive BigDecimal + * Long value of a positive BigDecimal. */ public void testLongValuePos() { String a = "123809648392384754573567356745735.63567890295784902768787678287E+21"; @@ -218,7 +218,7 @@ } /** - * scaleByPowerOfTen(int n) + * scaleByPowerOfTen(int n). */ public void testScaleByPowerOfTen1() { String a = "1231212478987482988429808779810457634781384756794987"; @@ -232,7 +232,7 @@ } /** - * scaleByPowerOfTen(int n) + * scaleByPowerOfTen(int n). */ public void testScaleByPowerOfTen2() { String a = "1231212478987482988429808779810457634781384756794987"; @@ -246,7 +246,7 @@ } /** - * toBigIntegerExact() + * toBigIntegerExact(). */ public void testToBigIntegerExact1() { String a = "-123809648392384754573567356745735.63567890295784902768787678287E+45"; @@ -257,7 +257,7 @@ } /** - * toBigIntegerExact() + * toBigIntegerExact(). */ public void testToBigIntegerExactException() { String a = "-123809648392384754573567356745735.63567890295784902768787678287E-10"; @@ -271,7 +271,7 @@ } /** - * Convert a negative BigDecimal to BigInteger + * Convert a negative BigDecimal to BigInteger. */ public void testToBigIntegerNeg1() { String a = "-123809648392384754573567356745735.63567890295784902768787678287E+21"; @@ -283,7 +283,7 @@ } /** - * Convert a negative BigDecimal to BigInteger + * Convert a negative BigDecimal to BigInteger. */ public void testToBigIntegerNeg2() { String a = "-123809648392384754573567356745735.63567890295784902768787678287E+15"; @@ -295,7 +295,7 @@ } /** - * Convert a negative BigDecimal to BigInteger + * Convert a negative BigDecimal to BigInteger. */ public void testToBigIntegerNeg3() { String a = "-123809648392384754573567356745735.63567890295784902768787678287E+45"; @@ -307,7 +307,7 @@ } /** - * Convert a positive BigDecimal to BigInteger + * Convert a positive BigDecimal to BigInteger. */ public void testToBigIntegerPos1() { String a = "123809648392384754573567356745735.63567890295784902768787678287E+21"; @@ -319,7 +319,7 @@ } /** - * Convert a positive BigDecimal to BigInteger + * Convert a positive BigDecimal to BigInteger. */ public void testToBigIntegerPos2() { String a = "123809648392384754573567356745735.63567890295784902768787678287E+15"; @@ -331,7 +331,7 @@ } /** - * Convert a positive BigDecimal to BigInteger + * Convert a positive BigDecimal to BigInteger. */ public void testToBigIntegerPos3() { String a = "123809648392384754573567356745735.63567890295784902768787678287E+45"; @@ -343,7 +343,7 @@ } /** - * Convert a small BigDecimal to BigInteger + * Convert a small BigDecimal to BigInteger. */ public void testToBigIntegerZero() { String a = "-123809648392384754573567356745735.63567890295784902768787678287E-500"; @@ -354,7 +354,7 @@ } /** - * Convert a negative BigDecimal to an engineering string representation + * Convert a negative BigDecimal to an engineering string representation. */ public void testToEngineeringStringNeg() { String a = "-123809648392384754573567356745735.63567890295784902768787678287E-501"; @@ -364,7 +364,7 @@ } /** - * Convert a positive BigDecimal to an engineering string representation + * Convert a positive BigDecimal to an engineering string representation. */ public void testToEngineeringStringPos() { String a = "123809648392384754573567356745735.63567890295784902768787678287E-501"; @@ -374,7 +374,7 @@ } /** - * Convert a negative BigDecimal to an engineering string representation + * Convert a negative BigDecimal to an engineering string representation. */ public void testToEngineeringStringZeroNegExponent() { String a = "0.0E-16"; @@ -384,7 +384,7 @@ } /** - * Convert a negative BigDecimal to an engineering string representation + * Convert a negative BigDecimal to an engineering string representation. */ public void testToEngineeringStringZeroPosExponent() { String a = "0.0E+16"; @@ -438,7 +438,7 @@ } /** - * Convert a negative BigDecimal to a string representation + * Convert a negative BigDecimal to a string representation. */ public void testToStringNeg() { String a = "-123.4564563673567380964839238475457356735674573563567890295784902768787678287E-5"; @@ -448,7 +448,7 @@ } /** - * Convert a positive BigDecimal to a string representation + * Convert a positive BigDecimal to a string representation. */ public void testToStringPos() { String a = "123809648392384754573567356745735.63567890295784902768787678287E-500"; @@ -468,7 +468,7 @@ } /** - * valueOf(Double.NaN) + * valueOf(Double.NaN). */ public void testValueOfDoubleNaN() { double a = Double.NaN; @@ -481,7 +481,7 @@ } /** - * Create a BigDecimal from a negative double value + * Create a BigDecimal from a negative double value. */ public void testValueOfDoubleNeg() { double a = -65678765876567576.98788767; @@ -493,7 +493,7 @@ } /** - * Create a BigDecimal from a positive double value + * Create a BigDecimal from a positive double value. */ public void testValueOfDoublePos1() { double a = 65678765876567576.98788767; @@ -505,7 +505,7 @@ } /** - * Create a BigDecimal from a positive double value + * Create a BigDecimal from a positive double value. */ public void testValueOfDoublePos2() { double a = 12321237576.98788767; @@ -517,7 +517,7 @@ } /** - * Create a BigDecimal from a positive double value + * Create a BigDecimal from a positive double value. */ public void testValueOfDoublePos3() { double a = 12321237576.9878838; @@ -529,7 +529,7 @@ } /** - * Create a BigDecimal from a negative long value; scale is negative + * Create a BigDecimal from a negative long value; scale is negative. */ public void testValueOfNegScaleNeg() { long a = -98374823947823578L; @@ -540,7 +540,7 @@ } /** - * Create a BigDecimal from a negative long value; scale is positive + * Create a BigDecimal from a negative long value; scale is positive. */ public void testValueOfNegScalePos() { long a = -98374823947823578L; @@ -551,7 +551,7 @@ } /** - * Create a BigDecimal from a negative long value; scale is 0 + * Create a BigDecimal from a negative long value; scale is 0. */ public void testValueOfNegZeroScale() { long a = -98374823947823578L; @@ -561,7 +561,7 @@ } /** - * Create a BigDecimal from a negative long value; scale is negative + * Create a BigDecimal from a negative long value; scale is negative. */ public void testValueOfPosScaleNeg() { long a = 98374823947823578L; @@ -572,7 +572,7 @@ } /** - * Create a BigDecimal from a negative long value; scale is positive + * Create a BigDecimal from a negative long value; scale is positive. */ public void testValueOfPosScalePos() { long a = 98374823947823578L; @@ -583,7 +583,7 @@ } /** - * Create a BigDecimal from a positive long value; scale == 0 + * Create a BigDecimal from a positive long value; scale == 0. */ public void testValueOfPosZeroScale() { long a = 98374823947823578L; -- http://groups.google.com/group/Google-Web-Toolkit-Contributors
