You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2019/06/30 21:55:56 UTC

[commons-numbers] 09/09: Javadoc.

This is an automated email from the ASF dual-hosted git repository.

erans pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-numbers.git

commit a796401f4a695738ed72512dd2a3920c71d7bb23
Author: Gilles Sadowski <gi...@harfang.homelinux.org>
AuthorDate: Sun Jun 30 23:54:57 2019 +0200

    Javadoc.
---
 .../java/org/apache/commons/numbers/fraction/BigFraction.java  | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

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 6d33b62..e3ca390 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
@@ -225,10 +225,10 @@ public class BigFraction extends Number implements Comparable<BigFraction>, Seri
      * <p>
      * Since this conversion is exact and since double numbers are sometimes
      * approximated, the fraction created may seem strange in some cases. For example,
-     * calling <code>new BigFraction(1.0 / 3.0)</code> does <em>not</em> create
-     * the fraction 1/3, but the fraction 6004799503160661 / 18014398509481984
-     * because the double number passed to the constructor is not exactly 1/3
-     * (this number cannot be stored exactly in IEEE754).
+     * calling {@code new BigFraction(1.0 / 3.0)} does <em>not</em> create
+     * the fraction \( \frac{1}{3} \), but the fraction \( \frac{6004799503160661}{18014398509481984} \)
+     * because the double number passed to the constructor is not exactly \( \frac{1}{3} \)
+     * (which cannot be represented exactly in IEEE754).
      * </p>
      *
      * @param value Value to convert to a fraction.
@@ -293,7 +293,7 @@ public class BigFraction extends Number implements Comparable<BigFraction>, Seri
      *
      * @param value Value to convert to a fraction.
      * @param epsilon Maximum error allowed. The resulting fraction is within
-     * <code>epsilon</code> of <code>value</code>, in absolute terms.
+     * {@code epsilon} of {@code value}, in absolute terms.
      * @param maxIterations Maximum number of convergents.
      * @throws ArithmeticException if the continued fraction failed to converge.
      * @return a new instance.