Author: sebb
Date: Sat Feb 14 12:59:04 2009
New Revision: 744494
URL: http://svn.apache.org/viewvc?rev=744494&view=rev
Log:
Javadoc fixes
Modified:
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/BigMoney.java
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/Money.java
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/MoneyUtils.java
Modified:
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/BigMoney.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/BigMoney.java?rev=744494&r1=744493&r2=744494&view=diff
==============================================================================
---
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/BigMoney.java
(original)
+++
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/BigMoney.java
Sat Feb 14 12:59:04 2009
@@ -59,7 +59,7 @@
* <p>
* This allows you to create an instance with a specific currency and
amount.
*
- * @param currency the currency, not null
+ * @param currencyCode the currency, not null
* @param amount the amount of money, not null
* @return the new instance, never null
* @throws IllegalArgumentException if the currency is unknown
@@ -93,7 +93,7 @@
* The amount is a whole number only. Thus you can initialise the value
* 'USD 20', but not the value 'USD 20.32'.
*
- * @param currency the currency, not null
+ * @param currencyCode the currency, not null
* @param amountMain the amount of money in the main division of the
currency
* @return the new instance, never null
* @throws IllegalArgumentException if the currency is unknown
@@ -241,8 +241,7 @@
/**
* Returns a new instance with the specified number of decimal places.
*
- * @param currency the currency to use, not null
- * @param amount the amount of money, not null
+ * @param decimalPlaces the number of decimal places
*/
public BigMoney withDecimalPlaces(int decimalPlaces) {
return BigMoney.of(iCurrency, iAmount.negate());
@@ -335,8 +334,6 @@
* <p>
* This instance is immutable and unaffected by this method.
*
- * @param currency the currency to use, not null
- * @param amount the amount of money, not null
*/
public BigMoney negated() {
return BigMoney.of(iCurrency, iAmount.negate());
@@ -348,6 +345,7 @@
*
* @return the monetary value, never null
*/
+ @Override
public String toString() {
return iCurrency.getCurrencyCode() + " " + iAmount.toPlainString();
}
Modified:
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/Money.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/Money.java?rev=744494&r1=744493&r2=744494&view=diff
==============================================================================
---
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/Money.java
(original)
+++
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/Money.java
Sat Feb 14 12:59:04 2009
@@ -69,7 +69,7 @@
* <p>
* This allows you to create an instance with a specific currency and
amount.
*
- * @param currency the currency, not null
+ * @param currencyCode the currency, not null
* @param amount the amount of money, not null
* @return the new instance, never null
* @throws IllegalArgumentException if the currency is unknown
@@ -105,7 +105,7 @@
* The amount is a whole number only. Thus you can initialise the value
* 'USD 20', but not the value 'USD 20.32'.
*
- * @param currency the currency, not null
+ * @param currencyCode the currency, not null
* @param amountMajor the amount of money in the major division of the
currency
* @return the new instance, never null
* @throws IllegalArgumentException if the currency is unknown
@@ -142,7 +142,7 @@
* For example, if constructing US Dollars, the input to this method
represents cents.
* Note that when a currency has zero decimal places, the major and minor
units are the same.
*
- * @param currency the currency, not null
+ * @param currencyCode the currency, not null
* @param amountMinor the amount of money in the minor division of the
currency
* @return the new instance, never null
* @throws IllegalArgumentException if the currency is unknown
Modified:
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/MoneyUtils.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/MoneyUtils.java?rev=744494&r1=744493&r2=744494&view=diff
==============================================================================
---
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/MoneyUtils.java
(original)
+++
commons/sandbox/money/trunk/src/main/java/org/apache/commons/money/MoneyUtils.java
Sat Feb 14 12:59:04 2009
@@ -29,12 +29,11 @@
//-----------------------------------------------------------------------
/**
- * Gets an instance of the Money from a string.
- * <p>
- * The string format is
+ * Check whether the Object is null.
*
- * @param moneyStr the money string to parse, not null
- * @return the parsed instance, never null
+ * @param object the object to check for null
+ * @param message string to pass to NullPointerException
+ *
* @throws NullPointerException if the input value is null
*/
static void checkNotNull(Object object, String message) {
