2008-08-08 Claudio Saavedra <csaavedra@igalia.com>

* src/hildon-date-button.c: Document the widget.
	* src/hildon-time-button.c: Document the widget.

diff --git a/ChangeLog b/ChangeLog
index 597684f..03df35b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2008-08-08  Claudio Saavedra  <csaavedra@igalia.com>
 
+       * src/hildon-date-button.c: Document the widget.
+       * src/hildon-time-button.c: Document the widget.
+
+2008-08-08  Claudio Saavedra  <csaavedra@igalia.com>
+
        * src/hildon-picker-button.c: Document the widget.
        * src/hildon-touch-selector-entry.c: Document the widget.
 

diff --git a/src/hildon-date-button.c b/src/hildon-date-button.c
index 955cb53..10a9488 100644 (file)
--- a/src/hildon-date-button.c
+++ b/src/hildon-date-button.c
@@ -14,6 +14,17 @@
  *
  */
 
+/**
+ * SECTION:hildon-date-button
+ * @Short_Description: Button displaying and allowing selection of a date.
+ * @See_Also: #HildonPickerButton, #HildonTimeButton
+ *
+ * #HildonDateButton is a widget that shows a text label and a date, and allows
+ * the user to select a different date. Visually, it's a button that, once clicked,
+ * presents a #HildonPickerDialog containing a #HildonDateSelector. Once the user selects
+ * a different date from the selector, this will be shown in the button.
+ */
+
 #include "hildon-date-selector.h"
 #include "hildon-touch-selector.h"
 #include "hildon-picker-button.h"
@@ -78,6 +89,16 @@ hildon_date_button_init (HildonDateButton * self)
                                      HILDON_TOUCH_SELECTOR (date_selector));
 }
 
+/**
+ * hildon_date_button_new:
+ * @size: One of #HildonSizeType
+ * @arrangement: one of #HildonButtonArrangement
+ *
+ * Creates a new #HildonDateButton. See hildon_button_new() for details on the
+ * parameters.
+ *
+ * Returns: a new #HildonDateButton
+ **/
 GtkWidget *
 hildon_date_button_new (HildonSizeType          size,
                         HildonButtonArrangement arrangement)
@@ -89,6 +110,15 @@ hildon_date_button_new (HildonSizeType          size,
                        NULL);
 }
 
+/**
+ * hildon_date_button_get_date:
+ * @button: a #HildonDateButton
+ * @year: return location for the selected year
+ * @month: return location for the selected month
+ * @day: return location for the selected day
+ *
+ * Retrieves currently selected date from @button.
+ **/
 void
 hildon_date_button_get_date (HildonDateButton * button,
                              guint * year, guint * month, guint * day)
@@ -102,6 +132,17 @@ hildon_date_button_get_date (HildonDateButton * button,
   hildon_date_selector_get_date (HILDON_DATE_SELECTOR (selector), year, month, day);
 }
 
+/**
+ * hildon_date_button_set_date:
+ * @button: a #HildonDateButton
+ * @year: the year to set.
+ * @month: the month number to set.
+ * @day: the day of the month to set.
+ *
+ * Sets the date in @button. The date set will be displayed
+ * and will be the default selected option on the shown #HildonDateSelector.
+ *
+ **/
 void
 hildon_date_button_set_date (HildonDateButton * button,
                              guint year, guint month, guint day)

diff --git a/src/hildon-time-button.c b/src/hildon-time-button.c
index ff079cb..64d5851 100644 (file)
--- a/src/hildon-time-button.c
+++ b/src/hildon-time-button.c
@@ -14,6 +14,17 @@
  *
  */
 
+/**
+ * SECTION:hildon-time-button
+ * @Short_Description: Button displaying and allowing selection of a time.
+ * @See_Also: #HildonPickerButton, #HildonTimeButton
+ *
+ * #HildonTimeButton is a widget that shows a text label and a time, and allows
+ * the user to select a different time. Visually, it's a button that, once clicked,
+ * presents a #HildonPickerDialog containing a #HildonTimeSelector. Once the user selects
+ * a different time from the selector, this will be shown in the button.
+ */
+
 #include "hildon-time-selector.h"
 #include "hildon-touch-selector.h"
 #include "hildon-picker-button.h"
@@ -77,6 +88,16 @@ hildon_time_button_init (HildonTimeButton * self)
                                      HILDON_TOUCH_SELECTOR (time_selector));
 }
 
+/**
+ * hildon_time_button_new:
+ * @size: One of #HildonSizeType
+ * @arrangement: one of #HildonButtonArrangement
+ *
+ * Creates a new #HildonTimeButton. See hildon_button_new() for details on the
+ * parameters.
+ *
+ * Returns: a new #HildonTimeButton
+ **/
 GtkWidget *
 hildon_time_button_new (HildonSizeType          size,
                         HildonButtonArrangement arrangement)
@@ -85,6 +106,14 @@ hildon_time_button_new (HildonSizeType          size,
                        "title", "Time", "arrangement", arrangement, "size", size, NULL);
 }
 
+/**
+ * hildon_time_button_get_time:
+ * @button: a #HildonTimeButton
+ * @hours: return location for the hours of the time selected
+ * @minutes: return location for the minutes of the time selected
+ *
+ * Retrieves the time from @button.
+ **/
 void
 hildon_time_button_get_time (HildonTimeButton * button,
                              guint * hours, guint * minutes)
@@ -98,6 +127,15 @@ hildon_time_button_get_time (HildonTimeButton * button,
   hildon_time_selector_get_time (HILDON_TIME_SELECTOR (selector), hours, minutes);
 }
 
+/**
+ * hildon_time_button_set_time:
+ * @button: a #HildonTimeButton
+ * @hours: the hours to be set
+ * @minutes: the time to be set
+ *
+ * Sets the time to be displayed in @button. This time will
+ * be selected by default on the #HildonTimeSelector.
+ **/
 void
 hildon_time_button_set_time (HildonTimeButton * button,
                              guint hours, guint minutes)