[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdelibs/kdecore/date
From:       John Layt <john () layt ! net>
Date:       2010-12-14 11:23:32
Message-ID: 20101214112332.BB262AC8A7 () svn ! kde ! org
[Download RAW message or body]

SVN commit 1206435 by jlayt:

Improve dayOfWeek apidox


 M  +6 -0      kcalendarsystem.h  
 M  +8 -2      klocalizeddate.h  


--- trunk/KDE/kdelibs/kdecore/date/kcalendarsystem.h #1206434:1206435
@@ -661,6 +661,8 @@
     /**
      * Returns the day number of year for the given date
      *
+     * The days are numbered 1..daysInYear()
+     *
      * @param date the date to obtain day from
      * @return day of year number, -1 if input date not valid
      */
@@ -669,6 +671,10 @@
     /**
      * Returns the weekday number for the given date
      *
+     * The weekdays are numbered 1..7 for Monday..Sunday.
+     *
+     * This value is @em not affected by the value of weekStartDay()
+     *
      * @param date the date to obtain day from
      * @return day of week number, -1 if input date not valid
      */
--- trunk/KDE/kdelibs/kdecore/date/klocalizeddate.h #1206434:1206435
@@ -75,7 +75,7 @@
  * In this case you are responsible for the memory management of the KLocale
  * and KCalendarSystem.  This allows you to reuse this calendar across multiple
  * date instances without it being deleted under you.  It also allows you to
- * change any setting in the Locale and have it apply acrooss all those date
+ * change any setting in the Locale and have it apply across all those date
  * instances.  @warning Don't try changing the Calendar System via your Locale
  * instance, your KCalendarSystem instance will be deleted and all the dates
  * will be invalid!
@@ -98,7 +98,7 @@
  * formats defined in the Locale, although you can provide your own format in
  * either the KDE, POSIX, or UNICODE standards.
  *
- * @see formatDate() formatDate() formatWeek() formatDayOfWeek()
+ * @see formatDate() formatDate()
  *
  * @section parsing Date Parsing
  *
@@ -453,6 +453,8 @@
     /**
      * Returns the day number of year for the date
      *
+     * The days are numbered 1..daysInYear()
+     *
      * See @ref formatting for why you should never display this value.
      *
      * @see formatDate()
@@ -463,6 +465,10 @@
     /**
      * Returns the weekday number for the date
      *
+     * The weekdays are numbered 1..7 for Monday..Sunday.
+     *
+     * This value is @em not affected by the value of KLocale::weekStartDay()
+     *
      * See @ref formatting for why you should never display this value.
      *
      * @see formatDate()
[prev in list] [next in list] [prev in thread] [next in thread]