Author: adrianc
Date: Wed Feb 17 21:38:13 2010
New Revision: 911181
URL: http://svn.apache.org/viewvc?rev=911181&view=rev
Log:
Improved TimeDuration.java JavaDocs.
Modified:
ofbiz/trunk/framework/base/src/org/ofbiz/base/util/TimeDuration.java
Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/TimeDuration.java
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/TimeDuration.java?rev=911181&r1=911180&r2=911181&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/TimeDuration.java
(original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/TimeDuration.java Wed
Feb 17 21:38:13 2010
@@ -322,10 +322,10 @@
/** Returns a <code>TimeDuration</code> instance derived from a
<code>Number</code>
* instance. If <code>number</code> is <code>null</code>,
- * returns a zero <code>TimeDuration</code>. <p>The years and months
portions of the
- * returned object are based on a Gregorian calendar. <b>Note:</b> this
- * method should not be used to calculate elapsed time - use the elapsed
- * time constructor instead.</p>
+ * returns a zero <code>TimeDuration</code>.<p>This is a convenience method
+ * intended to be used with entity engine fields. Some duration fields are
+ * stored as a <code>Long</code>, while others are stored as a
+ * <code>Double</code>. This method will decode both types.</p>
*
* @param number A <code>Number</code> instance, can be <code>null</code>
* @return A <code>TimeDuration</code> instance
