Fiat: Fix comments.

This commit is contained in:
Andreas Schildbach
2016-10-22 18:37:02 +02:00
parent 7a1613a48d
commit 9cfa0a35a1

View File

@@ -80,7 +80,7 @@ public final class Fiat implements Monetary, Comparable<Fiat>, Serializable {
* "1.23E3", "1234.5E-5".
*
* @throws IllegalArgumentException
* if you try to specify fractional satoshis, or a value out of range.
* if you try to specify more than 4 digits after the comma, or a value out of range.
*/
public static Fiat parseFiat(final String currencyCode, final String str) {
try {
@@ -141,7 +141,7 @@ public final class Fiat implements Monetary, Comparable<Fiat>, Serializable {
}
/**
* Returns true if the monetary value represented by this instance is greater than that of the given other Coin,
* Returns true if the monetary value represented by this instance is greater than that of the given other Fiat,
* otherwise false.
*/
public boolean isGreaterThan(Fiat other) {
@@ -149,7 +149,7 @@ public final class Fiat implements Monetary, Comparable<Fiat>, Serializable {
}
/**
* Returns true if the monetary value represented by this instance is less than that of the given other Coin,
* Returns true if the monetary value represented by this instance is less than that of the given other Fiat,
* otherwise false.
*/
public boolean isLessThan(Fiat other) {
@@ -168,7 +168,7 @@ public final class Fiat implements Monetary, Comparable<Fiat>, Serializable {
}
/**
* Returns the number of satoshis of this monetary value. It's deprecated in favour of accessing {@link #value}
* Returns the number of "smallest units" of this monetary value. It's deprecated in favour of accessing {@link #value}
* directly.
*/
public long longValue() {
@@ -189,8 +189,8 @@ public final class Fiat implements Monetary, Comparable<Fiat>, Serializable {
/**
* <p>
* Returns the value as a plain string denominated in BTC. The result is unformatted with no trailing zeroes. For
* instance, a value of 150000 satoshis gives an output string of "0.0015" BTC
* Returns the value as a plain string. The result is unformatted with no trailing zeroes. For
* instance, a value of 150000 "smallest units" gives an output string of "0.0015".
* </p>
*/
public String toPlainString() {