Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 6790B200C22 for ; Mon, 6 Feb 2017 13:52:26 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 654FA160B6C; Mon, 6 Feb 2017 12:52:26 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 09F3F160B53 for ; Mon, 6 Feb 2017 13:52:24 +0100 (CET) Received: (qmail 22926 invoked by uid 500); 6 Feb 2017 12:52:23 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 22278 invoked by uid 99); 6 Feb 2017 12:52:23 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 06 Feb 2017 12:52:23 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id C3F99E04D6; Mon, 6 Feb 2017 12:52:22 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: raydecampo@apache.org To: commits@commons.apache.org Date: Mon, 06 Feb 2017 12:52:31 -0000 Message-Id: <16413676f7ad4355a3e4fb76a883e34b@git.apache.org> In-Reply-To: <565b4309f95a498c9852aa968f17777a@git.apache.org> References: <565b4309f95a498c9852aa968f17777a@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [10/13] commons-numbers git commit: NUMBERS-6: Fix javadoc errors archived-at: Mon, 06 Feb 2017 12:52:26 -0000 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 Authored: Tue Jan 31 20:32:37 2017 -0500 Committer: Ray DeCampo 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 *
  • * Continued Fraction equations (11) and (22)-(26)
    • * - *

    * * @param value * the double value to convert to a fraction. @@ -209,7 +208,7 @@ public class BigFraction * epsilon of value, 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 *
  • * Continued Fraction equations (11) and (22)-(26)
    • * - *

    * * @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 *
  • * Continued Fraction equations (11) and (22)-(26)
    • * - *

    + * * @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 *
  • * Continued Fraction equations (11) and (22)-(26)
    • * - *

    + * * @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 obj is not a valid type. */ @Override