svn commit: r1467387 - /commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FormatCache.java

[se...@apache.org]

Author: sebb
Date: Fri Apr 12 18:05:03 2013
New Revision: 1467387

URL: http://svn.apache.org/r1467387
Log:
Javadoc corrections

Modified:
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FormatCache.java

Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FormatCache.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FormatCache.java?rev=1467387&r1=1467386&r2=1467387&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FormatCache.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/time/FormatCache.java Fri Apr 12 18:05:03 2013
@@ -59,9 +59,9 @@ abstract class FormatCache<F extends For
      * and locale.</p>
      * 
      * @param pattern  {@link java.text.SimpleDateFormat} compatible
-     *  pattern
-     * @param timeZone  the non-null time zone
-     * @param locale  the non-null locale
+     *  pattern, non-null
+     * @param timeZone  the time zone, null means use the default TimeZone
+     * @param locale  the locale, null means use the default Locale
      * @return a pattern based date/time formatter
      * @throws IllegalArgumentException if pattern is invalid
      *  or <code>null</code>
@@ -107,10 +107,10 @@ abstract class FormatCache<F extends For
      * <p>Gets a date/time formatter instance using the specified style,
      * time zone and locale.</p>
      * 
-     * @param dateStyle  date style: FULL, LONG, MEDIUM, or SHORT
-     * @param timeStyle  time style: FULL, LONG, MEDIUM, or SHORT
+     * @param dateStyle  date style: FULL, LONG, MEDIUM, or SHORT, null indicates no date in format
+     * @param timeStyle  time style: FULL, LONG, MEDIUM, or SHORT, null indicates no time in format
      * @param timeZone  optional time zone, overrides time zone of
-     *  formatted date
+     *  formatted date, null means use default Locale
      * @param locale  optional locale, overrides system locale
      * @return a localized standard date/time formatter
      * @throws IllegalArgumentException if the Locale has no date/time