Fix and extend Javadoc for setFirstDayOfWeek (#19227)

The Javadoc was incorrect saying the method goal was to set the first
day of week depending on locale. Actual main goal - to set it in
independent way.
Also extended the doc to look more complete.
Change-Id: I2c82c774f4e245437b03c0bd0246a0361584d949

diff --git a/server/src/com/vaadin/ui/Calendar.java b/server/src/com/vaadin/ui/Calendar.java
index f0ae50fe89aa5c3a0eda7942fee932926317eabe..028a094cb52afa588704db62312deaeb57b53c83 100644 (file)
--- a/server/src/com/vaadin/ui/Calendar.java
+++ b/server/src/com/vaadin/ui/Calendar.java
@@ -1998,11 +1998,13 @@ public class Calendar extends AbstractComponent implements
     }
 
     /**
-     * Allow setting first day of week depending on Locale. Set to null if you
-     * want first day of week depend on locale
+     * Allow setting first day of week independent of Locale. Set to null if you
+     * want first day of week being defined by the locale
      * 
      * @since 7.6
      * @param dayOfWeek
+     *            any of java.util.Calendar.SUNDAY..java.util.Calendar.SATURDAY
+     *            or null to revert to default first day of week by locale
      */
     public void setFirstDayOfWeek(Integer dayOfWeek) {
         int minimalSupported = java.util.Calendar.SUNDAY;