Update HildonDateSelector documentation

* hildon/hildon-date-selector.c
(hildon_date_selector_select_current_date)
(hildon_date_selector_get_date)
(hildon_date_selector_select_day):
Update the documentation: uses always the range (1-31), as it is obvious
that the final one will depend on the month and the year, but globally
the range is this, in a similar GtkCalendar approach
(hildon_date_selector_get_date):
Update the documentation: add NULL as a valid value for the day, month
and year locations

Fix some details, after talk with David King on bug MB#4698

diff --git a/ChangeLog b/ChangeLog
index e3b005c..ac1be9e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,18 @@
+2009-06-17  Alejandro Pinheiro <apinheiro@igalia.com>
+
+       * hildon/hildon-date-selector.c
+       (hildon_date_selector_select_current_date)
+       (hildon_date_selector_get_date)
+       (hildon_date_selector_select_day):
+       Update the documentation: uses always the range (1-31), as it is obvious
+       that the final one will depend on the month and the year, but globally
+       the range is this, in a similar GtkCalendar approach
+       (hildon_date_selector_get_date):
+       Update the documentation: add NULL as a valid value for the day, month
+       and year locations
+
+       Fix some details, after talk with David King on bug MB#4698
+
 2009-06-18  Alejandro Pinheiro <apinheiro@igalia.com>
 
        * hildon/hildon-touch-selector-entry.c

diff --git a/hildon/hildon-date-selector.c b/hildon/hildon-date-selector.c
index b24e9b7..035c680 100644 (file)
--- a/hildon/hildon-date-selector.c
+++ b/hildon/hildon-date-selector.c
@@ -761,8 +761,8 @@ hildon_date_selector_new_with_year_range (gint min_year,
  * hildon_date_selector_select_current_date:
  * @selector: the #HildonDateSelector
  * @year:  the current year
- * @month: the current month (0-11)
- * @day:   the current day (1-31, 1-30, 1-29, 1-28) depends on the month
+ * @month: the current month (between 0 and 11)
+ * @day:   the current day (between 1 and 31)
  *
  * Sets the current active date on the #HildonDateSelector widget
  *
@@ -814,9 +814,9 @@ hildon_date_selector_select_current_date (HildonDateSelector * selector,
 /**
  * hildon_date_selector_get_date:
  * @selector: the #HildonDateSelector
- * @year:  location of the current year
- * @month: location of the current month (0-11)
- * @day:   location of the current day (1-31, 1-30, 1-29, 1-28), depends on the month and the year
+ * @year:  location of the current year, or NULL
+ * @month: location of the current month (between 0 and 11), or NULL
+ * @day:   location of the current day (between 1 and 31), or NULL
  *
  * Gets the current active date on the #HildonDateSelector widget
  *
@@ -883,7 +883,7 @@ gboolean hildon_date_selector_select_month (HildonDateSelector *selector,
 /**
  * hildon_date_selector_select_day:
  * @selector: the #HildonDateSelector
- * @day:   the current day (1-31, 1-30, 1-29, 1-28), depends on the month and the year
+ * @day:   the current day (between 1 and 31)
  *
  * Modify the current day on the current active date
  *