DateSelector documentation fixes

* hildon/hildon-date-selector.c
(hildon_date_selector_select_current_date)
(hildon_date_selector_get_date): Update documentation regarding days,
as the day of the month is dependent on both the month and the year.
(hildon_date_selector_get_date): Fix documentation of output arguments.

Fixes: MB#4698 (DateSelector documentation has bad output argument
description, and the day depends on both the month and the year)

Signed-off-by: Claudio Saavedra <csaavedra@igalia.com>

diff --git a/ChangeLog b/ChangeLog
index 9b20393..38a2397 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2009-06-17  David King  <davidk@openismus.com>
+
+       * hildon/hildon-date-selector.c
+       (hildon_date_selector_select_current_date)
+       (hildon_date_selector_get_date): Update documentation regarding days,
+       as the day of the month is dependent on both the month and the year.
+       (hildon_date_selector_get_date): Fix documentation of output arguments.
+
+       Fixes: MB#4698 (DateSelector documentation has bad output argument
+       description, and the day depends on both the month and the year)
+
 2009-06-17  Claudio Saavedra  <csaavedra@igalia.com>
 
        * hildon/hildon-caption.c: Other documentation fixes to

diff --git a/hildon/hildon-date-selector.c b/hildon/hildon-date-selector.c
index ba5ef33..b24e9b7 100644 (file)
--- a/hildon/hildon-date-selector.c
+++ b/hildon/hildon-date-selector.c
@@ -814,9 +814,9 @@ hildon_date_selector_select_current_date (HildonDateSelector * selector,
 /**
  * hildon_date_selector_get_date:
  * @selector: the #HildonDateSelector
- * @year:  to set the current year
- * @month: to set the current month (0-11)
- * @day:   to the current day (1-31, 1-30, 1-29, 1-28) depends on the month
+ * @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
  *
  * 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
+ * @day:   the current day (1-31, 1-30, 1-29, 1-28), depends on the month and the year
  *
  * Modify the current day on the current active date
  *