You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ra...@apache.org on 2017/02/06 12:52:31 UTC
[10/13] commons-numbers git commit: NUMBERS-6: Fix javadoc errors
NUMBERS-6: Fix javadoc errors
Project: http://git-wip-us.apache.org/repos/asf/commons-numbers/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-numbers/commit/ffe11d9d
Tree: http://git-wip-us.apache.org/repos/asf/commons-numbers/tree/ffe11d9d
Diff: http://git-wip-us.apache.org/repos/asf/commons-numbers/diff/ffe11d9d
Branch: refs/heads/master
Commit: ffe11d9d884594f08792f688bf5c78c9e07e61dd
Parents: ec826b0
Author: Ray DeCampo <ra...@decampo.org>
Authored: Tue Jan 31 20:32:37 2017 -0500
Committer: Ray DeCampo <ra...@decampo.org>
Committed: Tue Jan 31 20:32:37 2017 -0500
----------------------------------------------------------------------
.../apache/commons/numbers/fraction/BigFraction.java | 12 +++++-------
.../org/apache/commons/numbers/fraction/Fraction.java | 4 ++--
.../apache/commons/numbers/fraction/FractionFormat.java | 2 +-
3 files changed, 8 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/ffe11d9d/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/BigFraction.java
----------------------------------------------------------------------
diff --git a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/BigFraction.java b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/BigFraction.java
index a5ab6f7..9d653b1 100644
--- a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/BigFraction.java
+++ b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/BigFraction.java
@@ -102,7 +102,7 @@ public class BigFraction
*
* @param num the numerator, must not be {@code null}.
* @param den the denominator, must not be {@code null}.
- * @throws ZeroDenominatorException if the denominator is zero.
+ * @throws ArithmeticException if the denominator is zero.
*/
public BigFraction(BigInteger num, BigInteger den) {
checkNotNull(num, "numerator");
@@ -200,7 +200,6 @@ public class BigFraction
* <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
* Continued Fraction</a> equations (11) and (22)-(26)</li>
* </ul>
- * </p>
*
* @param value
* the double value to convert to a fraction.
@@ -209,7 +208,7 @@ public class BigFraction
* <code>epsilon</code> of <code>value</code>, in absolute terms.
* @param maxIterations
* maximum number of convergents.
- * @throws FractionConversionException
+ * @throws ArithmeticException
* if the continued fraction failed to converge.
* @see #BigFraction(double)
*/
@@ -331,13 +330,12 @@ public class BigFraction
* <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
* Continued Fraction</a> equations (11) and (22)-(26)</li>
* </ul>
- * </p>
*
* @param value
* the double value to convert to a fraction.
* @param maxDenominator
* The maximum allowed value for denominator.
- * @throws FractionConversionException
+ * @throws ArithmeticException
* if the continued fraction failed to converge.
*/
public BigFraction(final double value, final int maxDenominator) {
@@ -617,7 +615,7 @@ public class BigFraction
*
* @param bg the {@code BigInteger} to divide by, must not be {@code null}
* @return a {@link BigFraction} instance with the resulting values
- * @throws ZeroDenominatorException if the fraction to divide by is zero
+ * @throws ArithmeticException if the fraction to divide by is zero
*/
public BigFraction divide(final BigInteger bg) {
checkNotNull(bg, "bg");
@@ -666,7 +664,7 @@ public class BigFraction
*
* @param fraction Fraction to divide by, must not be {@code null}.
* @return a {@link BigFraction} instance with the resulting values.
- * @throws ZeroDenominatorException if the fraction to divide by is zero
+ * @throws ArithmeticException if the fraction to divide by is zero
*/
public BigFraction divide(final BigFraction fraction) {
checkNotNull(fraction, "fraction");
http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/ffe11d9d/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/Fraction.java
----------------------------------------------------------------------
diff --git a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/Fraction.java b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/Fraction.java
index bfd7734..1697d8d 100644
--- a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/Fraction.java
+++ b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/Fraction.java
@@ -101,7 +101,7 @@ public class Fraction
* <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
* Continued Fraction</a> equations (11) and (22)-(26)</li>
* </ul>
- * </p>
+ *
* @param value the double value to convert to a fraction.
* @param epsilon maximum error allowed. The resulting fraction is within
* {@code epsilon} of {@code value}, in absolute terms.
@@ -122,7 +122,7 @@ public class Fraction
* <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
* Continued Fraction</a> equations (11) and (22)-(26)</li>
* </ul>
- * </p>
+ *
* @param value the double value to convert to a fraction.
* @param maxDenominator The maximum allowed value for denominator
* @throws IllegalArgumentException if the continued fraction failed to
http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/ffe11d9d/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/FractionFormat.java
----------------------------------------------------------------------
diff --git a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/FractionFormat.java b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/FractionFormat.java
index cc34cac..2189724 100644
--- a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/FractionFormat.java
+++ b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/FractionFormat.java
@@ -159,7 +159,7 @@ public class FractionFormat extends AbstractFormat {
* offsets of the alignment field
* @return the value passed in as toAppendTo.
* @see java.text.Format#format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)
- * @throws FractionConversionException if the number cannot be converted to a fraction
+ * @throws ArithmeticException if the number cannot be converted to a fraction
* @throws IllegalArgumentException if <code>obj</code> is not a valid type.
*/
@Override