Skip to content

Commit 553edc9

Browse files
committed
Fixed API Javadoc.
1 parent cc1381e commit 553edc9

File tree

2 files changed

+10
-16
lines changed

2 files changed

+10
-16
lines changed

money-api/src/main/java/javax/money/CurrencyUnit.java

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@
1717
* US Dollar, Bitcoin or other. It is mainly defined to provide interoperability
1818
* between different implementations.
1919
* <p>
20-
* Currencies can be distinguished within separate arbitrary currency name
21-
* spaces, whereas as {@link #ISO_NAMESPACE} will be the the most commonly used
22-
* one, similar to {@link java.util.Currency}.
20+
* Currencies can be distinguished by separate {@link #getCurrencyCode()} codes,
21+
* similar to {@link java.util.Currency}.
2322
* <p>
2423
* Implementation of this class are required to be
2524
* <ul>
@@ -37,23 +36,18 @@
3736
public interface CurrencyUnit {
3837

3938
/**
40-
* Gets the currency code, the effective code depends on the currency and
41-
* the name space. It is possible that the two currency may have the same
42-
* code, but different name spaces.
39+
* Gets the unique currency code, the effective code depends on the
40+
* currency.
4341
* <p>
44-
* Each currency is uniquely identified within its name space by this code.
45-
* As a consequence the currency code is required to be uniqie in
46-
* combination with the namespace and not {@code null} or empty.
47-
* <p>
48-
* This method matches basically the API of <type>java.util.Currency</type>.
42+
* Since each currency is identified by this code, the currency code is
43+
* required to be defined for every {@link CurrencyUnit} and not
44+
* {@code null} or empty.
4945
*
50-
* @see #getNamespace()
5146
* @return the currency code, never {@code null}. For the ISO-4217
5247
* namespace, this this will be the three letter ISO-4217 code.
53-
* However, alternate namespaces can have different codes. Also
48+
* However, alternate currencies can have different codes. Also
5449
* there is no constraint about the formatting of alternate codes,
55-
* despite they have to be unique within its corresponding
56-
* namespace.
50+
* despite they fact that the currency codes must be unique.
5751
*/
5852
public String getCurrencyCode();
5953

money-api/src/main/java/javax/money/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* reserved.
1010
*/
1111
/**
12-
* Money and Currencies core API.
12+
* Money and Currencies API.
1313
*/
1414
package javax.money;
1515

0 commit comments

Comments
 (0)