LANG-1638: Added docs regarding week year support (#924)
* LANG-1638: Added docs regarding week year support
* Moved comment from method to class level
* Added link to explanation of week vs calendar year
diff --git a/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java b/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java
index 1410e0c..1688c31 100644
--- a/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java
+++ b/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java
@@ -30,6 +30,10 @@
* <p>Note that the JDK has a bug wherein calling Calendar.get(int) will
* override any previously called Calendar.clear() calls. See LANG-755.</p>
*
+ * <p>Note that when using capital YYYY instead of lowercase yyyy, the formatter
+ * will assume current year as week year is not supported. See {@link java.util.GregorianCalendar}
+ * Week Year section for an explanation on the difference between calendar and week years.</p>
+ *
* @since 2.0
*/
public class DateFormatUtils {
