2008-12-12 Alberto Garcia <agarcia@igalia.com>

* doc/hildon-sections.txt
	* src/hildon-pannable-area.c
	* src/hildon-program.c
	* src/hildon-time-editor.c
	* src/hildon-touch-selector-entry.c:

	More documentation updates.

diff --git a/ChangeLog b/ChangeLog
index d3265c6..2cd341f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,16 @@
 2008-12-12  Alberto Garcia  <agarcia@igalia.com>
 
        * doc/hildon-sections.txt
+       * src/hildon-pannable-area.c
+       * src/hildon-program.c
+       * src/hildon-time-editor.c
+       * src/hildon-touch-selector-entry.c:
+
+       More documentation updates.
+
+2008-12-12  Alberto Garcia  <agarcia@igalia.com>
+
+       * doc/hildon-sections.txt
        * src/hildon-caption.c
        * src/hildon-code-dialog.c
        * src/hildon-color-button.c

diff --git a/doc/hildon-sections.txt b/doc/hildon-sections.txt
index 14ef13a..7145532 100644 (file)
--- a/doc/hildon-sections.txt
+++ b/doc/hildon-sections.txt
@@ -1146,6 +1146,7 @@ hildon_play_system_sound
 
 <SECTION>
 <FILE>hildon-enum-types</FILE>
+<SUBSECTION Standard>
 HILDON_TYPE_CAPTION_STATUS
 HILDON_TYPE_CAPTION_ICON_POSITION
 HILDON_TYPE_NOTE_TYPE
@@ -1161,7 +1162,6 @@ HILDON_TYPE_MOVEMENT_DIRECTION
 HILDON_TYPE_SIZE_REQUEST_POLICY
 HILDON_TYPE_BUTTON_ARRANGEMENT
 HILDON_TYPE_BUTTON_STYLE
-<SUBSECTION Standard>
 hildon_caption_status_get_type
 hildon_caption_icon_position_get_type
 hildon_note_type_get_type

diff --git a/src/hildon-pannable-area.c b/src/hildon-pannable-area.c
index 69fed5e..d92e693 100644 (file)
--- a/src/hildon-pannable-area.c
+++ b/src/hildon-pannable-area.c
@@ -2546,7 +2546,7 @@ hildon_pannable_get_child_widget_at (HildonPannableArea *area,
 
 
 /**
- * hildon_pannable_get_hadjustment:
+ * hildon_pannable_area_get_hadjustment:
  * @area: A #HildonPannableArea.
  *
  * Returns the horizontal adjustment
@@ -2563,7 +2563,7 @@ hildon_pannable_area_get_hadjustment            (HildonPannableArea *area)
 }
 
 /**
- * hildon_pannable_get_vadjustment:
+ * hildon_pannable_area_get_vadjustment:
  * @area: A #HildonPannableArea.
  *
  * Returns the vertical adjustment

diff --git a/src/hildon-program.c b/src/hildon-program.c
index 1f9b4eb..ad15381 100644 (file)
--- a/src/hildon-program.c
+++ b/src/hildon-program.c
@@ -422,9 +422,11 @@ hildon_program_common_toolbar_topmost_window    (gpointer window,
 /**
  * hildon_program_get_instance:
  *
- * Return value: Returns the #HildonProgram for the current process.
- * The object is created on the first call. Note that you're not supposed 
- * to unref the returned object since it's not reffed in the first place.
+ * Returns the #HildonProgram for the current process. The object is
+ * created on the first call. Note that you're not supposed to unref
+ * the returned object since it's not reffed in the first place.
+ *
+ * Return value: the #HildonProgram.
  **/
 HildonProgram*
 hildon_program_get_instance                     (void)
@@ -551,9 +553,11 @@ hildon_program_set_can_hibernate                (HildonProgram *self,
 /**
  * hildon_program_get_can_hibernate:
  * @self: The #HildonProgram which can hibernate or not
- * 
- * Return value: Whether or not this #HildonProgram is set to be
- * support hibernation from the Hildon task navigator
+ *
+ * Returns whether the #HildonProgram is set to be support hibernation
+ * from the Hildon task navigator
+ *
+ * Return value: %TRUE if the program can hibernate, %FALSE otherwise.
  **/
 gboolean
 hildon_program_get_can_hibernate                (HildonProgram *self)
@@ -627,8 +631,10 @@ hildon_program_set_common_menu                  (HildonProgram *self,
  * hildon_program_get_common_menu:
  * @self: The #HildonProgram from which to retrieve the common menu
  *
- * Return value: the GtkMenu that was set as common menu for this
- * #HildonProgram, or %NULL of no common menu was set.
+ * Returns the #GtkMenu that was set as common menu for this
+ * #HildonProgram.
+ *
+ * Return value: the #GtkMenu or %NULL of no common menu was set.
  **/
 GtkMenu*
 hildon_program_get_common_menu                  (HildonProgram *self)
@@ -692,8 +698,11 @@ hildon_program_set_common_app_menu              (HildonProgram *self,
  * hildon_program_get_common_app_menu:
  * @self: The #HildonProgram from which to retrieve the common app menu
  *
- * Return value: the #HildonAppMenu that was set as common menu for this
- * #HildonProgram, or %NULL of no common app menu was set.
+ * Returns the #HildonAppMenu that was set as common menu for this
+ * #HildonProgram.
+ *
+ * Return value: the #HildonAppMenu or %NULL of no common app menu was
+ * set.
  *
  * Since: 2.2
  **/
@@ -764,8 +773,11 @@ hildon_program_set_common_toolbar               (HildonProgram *self,
  * hildon_program_get_common_toolbar:
  * @self: The #HildonProgram from which to retrieve the common toolbar
  *
- * Return value: the GtkToolbar that was set as common toolbar for this
- * #HildonProgram, or %NULL of no common menu was set.
+ * Returns the #GtkToolbar that was set as common toolbar for this
+ * #HildonProgram.
+ *
+ * Return value: the #GtkToolbar or %NULL of no common toolbar was
+ * set.
  **/
 GtkToolbar*
 hildon_program_get_common_toolbar               (HildonProgram *self)
@@ -784,8 +796,11 @@ hildon_program_get_common_toolbar               (HildonProgram *self)
  * hildon_program_get_is_topmost:
  * @self: A #HildonWindow
  *
- * Return value: Whether or not one of the program's window or dialog is 
- * currenltly activated by the window manager.
+ * Returns whether one of the program's windows or dialogs is
+ * currently activated by the window manager.
+ *
+ * Return value: %TRUE if a window or dialog is topmost, %FALSE
+ * otherwise.
  **/
 gboolean
 hildon_program_get_is_topmost                   (HildonProgram *self)

diff --git a/src/hildon-time-editor.c b/src/hildon-time-editor.c
index 114af7c..717a67f 100644 (file)
--- a/src/hildon-time-editor.c
+++ b/src/hildon-time-editor.c
@@ -693,7 +693,7 @@ hildon_time_editor_get_property                 (GObject *object,
     }
 }
 
-/*
+/**
  * hildon_time_editor_new:
  *
  * This function creates a new time editor. 

diff --git a/src/hildon-touch-selector-entry.c b/src/hildon-touch-selector-entry.c
index d2e3183..779ffe6 100644 (file)
--- a/src/hildon-touch-selector-entry.c
+++ b/src/hildon-touch-selector-entry.c
@@ -185,6 +185,15 @@ hildon_touch_selector_entry_init (HildonTouchSelectorEntry *self)
   gtk_box_pack_start (GTK_BOX (self), priv->entry, FALSE, FALSE, 0);
 }
 
+/**
+ * hildon_touch_selector_entry_new:
+ *
+ * Creates a #HildonTouchSelectorEntry
+ *
+ * Returns: A new #HildonTouchSelectorEntry
+ *
+ * Since: 2.2
+ **/
 GtkWidget *
 hildon_touch_selector_entry_new (void)
 {