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
	* src/hildon-controlbar.c
	* src/hildon-date-editor.c
	* src/hildon-date-selector.c
	* src/hildon-edit-toolbar.c
	* src/hildon-find-toolbar.c
	* src/hildon-font-selection-dialog.c
	* src/hildon-gtk.c
	* src/hildon-program.c
	* src/hildon-range-editor.c
	* src/hildon-seekbar.c
	* src/hildon-time-editor.c
	* src/hildon-time-selector.c
	* src/hildon-volumebar-range.c
	* src/hildon-volumebar.c
	* src/hildon-vvolumebar.c
	* src/hildon-weekday-picker.c
	* src/hildon-window.c
	* src/hildon-wizard-dialog.c:

	Lots of documentation fixes.

diff --git a/ChangeLog b/ChangeLog
index dad7f94..d3265c6 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,30 @@
+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
+       * src/hildon-controlbar.c
+       * src/hildon-date-editor.c
+       * src/hildon-date-selector.c
+       * src/hildon-edit-toolbar.c
+       * src/hildon-find-toolbar.c
+       * src/hildon-font-selection-dialog.c
+       * src/hildon-gtk.c
+       * src/hildon-program.c
+       * src/hildon-range-editor.c
+       * src/hildon-seekbar.c
+       * src/hildon-time-editor.c
+       * src/hildon-time-selector.c
+       * src/hildon-volumebar-range.c
+       * src/hildon-volumebar.c
+       * src/hildon-vvolumebar.c
+       * src/hildon-weekday-picker.c
+       * src/hildon-window.c
+       * src/hildon-wizard-dialog.c:
+
+       Lots of documentation fixes.
+
 2008-12-12  Claudio Saavedra  <csaavedra@igalia.com>
 
        Patch contributed by Iván Gómez (igomez@igalia.com)

diff --git a/doc/hildon-sections.txt b/doc/hildon-sections.txt
index 6bf1a16..14ef13a 100644 (file)
--- a/doc/hildon-sections.txt
+++ b/doc/hildon-sections.txt
@@ -1,6 +1,5 @@
 <SECTION>
 <FILE>hildon-date-selector</FILE>
-HildonDateSelectorPrivate
 <TITLE>HildonDateSelector</TITLE>
 HildonDateSelector
 hildon_date_selector_new
@@ -17,6 +16,7 @@ HILDON_DATE_SELECTOR_CLASS
 HILDON_IS_DATE_SELECTOR_CLASS
 HILDON_DATE_SELECTOR_GET_CLASS
 HildonDateSelectorClass
+HildonDateSelectorPrivate
 </SECTION>
 
 <SECTION>
@@ -97,6 +97,8 @@ HILDON_BUTTON
 HILDON_IS_BUTTON
 HILDON_TYPE_BUTTON
 hildon_button_get_type
+hildon_button_arrangement_get_type
+hildon_button_style_get_type
 HILDON_BUTTON_CLASS
 HILDON_IS_BUTTON_CLASS
 HILDON_BUTTON_GET_CLASS
@@ -185,7 +187,6 @@ HildonCaptionClass
 
 <SECTION>
 <FILE>hildon-touch-selector-column</FILE>
-HildonTouchSelectorColumnPrivate
 <TITLE>HildonTouchSelectorColumn</TITLE>
 HildonTouchSelectorColumn
 <SUBSECTION Standard>
@@ -197,6 +198,7 @@ HILDON_TOUCH_SELECTOR_COLUMN_CLASS
 HILDON_IS_TOUCH_SELECTOR_COLUMN_CLASS
 HILDON_TOUCH_SELECTOR_COLUMN_GET_CLASS
 HildonTouchSelectorColumnClass
+HildonTouchSelectorColumnPrivate
 </SECTION>
 
 <SECTION>
@@ -222,7 +224,6 @@ HildonSortDialogClass
 
 <SECTION>
 <FILE>hildon-bread-crumb-widget</FILE>
-HildonBreadCrumbWidgetPrivate
 <TITLE>HildonBreadCrumbWidget</TITLE>
 HildonBreadCrumbWidget
 <SUBSECTION Standard>
@@ -234,6 +235,7 @@ HILDON_BREAD_CRUMB_WIDGET_CLASS
 HILDON_IS_BREAD_CRUMB_WIDGET_CLASS
 HILDON_BREAD_CRUMB_WIDGET_GET_CLASS
 HildonBreadCrumbWidgetClass
+HildonBreadCrumbWidgetPrivate
 </SECTION>
 
 <SECTION>
@@ -261,7 +263,6 @@ HildonFindToolbarClass
 <SECTION>
 <FILE>hildon-picker-dialog</FILE>
 HILDON_DISABLE_DEPRECATED
-HildonPickerDialogPrivate
 <TITLE>HildonPickerDialog</TITLE>
 HildonPickerDialog
 hildon_picker_dialog_new
@@ -278,6 +279,7 @@ HILDON_PICKER_DIALOG_CLASS
 HILDON_IS_PICKER_DIALOG_CLASS
 HILDON_PICKER_DIALOG_GET_CLASS
 HildonPickerDialogClass
+HildonPickerDialogPrivate
 </SECTION>
 
 <SECTION>
@@ -304,6 +306,7 @@ HILDON_CALENDAR_CLASS
 HILDON_IS_CALENDAR_CLASS
 HILDON_CALENDAR_GET_CLASS
 HildonCalendarClass
+hildon_calendar_display_options_get_type
 </SECTION>
 
 <SECTION>
@@ -347,7 +350,6 @@ HildonWeekdayPickerClass
 
 <SECTION>
 <FILE>hildon-app-menu</FILE>
-HildonAppMenuPrivate
 <TITLE>HildonAppMenu</TITLE>
 HildonAppMenu
 hildon_app_menu_new
@@ -365,6 +367,7 @@ HILDON_APP_MENU_CLASS
 HILDON_IS_APP_MENU_CLASS
 HILDON_APP_MENU_GET_CLASS
 HildonAppMenuClass
+HildonAppMenuPrivate
 </SECTION>
 
 <SECTION>
@@ -401,11 +404,11 @@ HILDON_TYPE_WIZARD_DIALOG
 HILDON_WIZARD_DIALOG_CLASS
 HILDON_IS_WIZARD_DIALOG_CLASS
 HildonWizardDialogClass
+hildon_wizard_dialog_response_get_type
 </SECTION>
 
 <SECTION>
 <FILE>hildon-bread-crumb-trail</FILE>
-HildonBreadCrumbTrailPrivate
 <TITLE>HildonBreadCrumbTrail</TITLE>
 HildonBreadCrumbTrail
 hildon_bread_crumb_trail_new
@@ -423,6 +426,7 @@ HILDON_BREAD_CRUMB_TRAIL_CLASS
 HILDON_IS_BREAD_CRUMB_TRAIL_CLASS
 HILDON_BREAD_CRUMB_TRAIL_GET_CLASS
 HildonBreadCrumbTrailClass
+HildonBreadCrumbTrailPrivate
 </SECTION>
 
 <SECTION>
@@ -449,7 +453,6 @@ HildonControlbarClass
 
 <SECTION>
 <FILE>hildon-check-button</FILE>
-HildonCheckButtonPrivate
 <TITLE>HildonCheckButton</TITLE>
 HildonCheckButton
 hildon_check_button_new
@@ -465,6 +468,7 @@ HILDON_CHECK_BUTTON_CLASS
 HILDON_IS_CHECK_BUTTON_CLASS
 HILDON_CHECK_BUTTON_GET_CLASS
 HildonCheckButtonClass
+HildonCheckButtonPrivate
 </SECTION>
 
 <SECTION>
@@ -473,7 +477,6 @@ HildonPannableAreaMode
 HildonMovementMode
 HildonMovementDirection
 HildonSizeRequestPolicy
-HildonPannableAreaPrivate
 <TITLE>HildonPannableArea</TITLE>
 HildonPannableArea
 hildon_pannable_area_new
@@ -488,17 +491,17 @@ hildon_pannable_area_get_size_request_policy
 hildon_pannable_area_set_size_request_policy
 hildon_pannable_area_get_hadjustment
 hildon_pannable_area_get_vadjustment
-hildon_pannable_area_set_hadjustment
-hildon_pannable_area_set_vadjustment
 <SUBSECTION Standard>
 HILDON_PANNABLE_AREA
 HILDON_IS_PANNABLE_AREA
 HILDON_TYPE_PANNABLE_AREA
 hildon_pannable_area_get_type
+hildon_size_request_policy_get_type
 HILDON_PANNABLE_AREA_CLASS
 HILDON_IS_PANNABLE_AREA_CLASS
 HILDON_PANNABLE_AREA_GET_CLASS
 HildonPannableAreaClass
+HildonPannableAreaPrivate
 </SECTION>
 
 <SECTION>
@@ -573,6 +576,7 @@ HILDON_NUMBER_EDITOR_CLASS
 HILDON_IS_NUMBER_EDITOR_CLASS
 HILDON_NUMBER_EDITOR_GET_CLASS
 HildonNumberEditorClass
+hildon_number_editor_error_type_get_type
 </SECTION>
 
 <SECTION>
@@ -691,6 +695,7 @@ HILDON_WINDOW_CLASS
 HILDON_IS_WINDOW_CLASS
 HILDON_WINDOW_GET_CLASS
 HildonWindowClass
+hildon_window_clipboard_operation_get_type
 </SECTION>
 
 <SECTION>
@@ -795,7 +800,6 @@ HildonColorChooserDialogClass
 
 <SECTION>
 <FILE>hildon-entry</FILE>
-HildonEntryPrivate
 <TITLE>HildonEntry</TITLE>
 HildonEntry
 hildon_entry_new
@@ -811,11 +815,11 @@ HILDON_ENTRY_CLASS
 HILDON_IS_ENTRY_CLASS
 HILDON_ENTRY_GET_CLASS
 HildonEntryClass
+HildonEntryPrivate
 </SECTION>
 
 <SECTION>
 <FILE>hildon-window-stack</FILE>
-HildonWindowStackPrivate
 <TITLE>HildonWindowStack</TITLE>
 HildonWindowStack
 hildon_window_stack_get_default
@@ -838,6 +842,7 @@ HILDON_WINDOW_STACK_CLASS
 HILDON_IS_WINDOW_STACK_CLASS
 HILDON_WINDOW_STACK_GET_CLASS
 HildonWindowStackClass
+HildonWindowStackPrivate
 </SECTION>
 
 <SECTION>
@@ -859,7 +864,6 @@ HildonFontSelectionDialogClass
 
 <SECTION>
 <FILE>hildon-touch-selector</FILE>
-HildonTouchSelectorPrivate
 HildonTouchSelectorPrintFunc
 <TITLE>HildonTouchSelector</TITLE>
 HildonTouchSelector
@@ -898,6 +902,7 @@ HILDON_TOUCH_SELECTOR_CLASS
 HILDON_IS_TOUCH_SELECTOR_CLASS
 HILDON_TOUCH_SELECTOR_GET_CLASS
 HildonTouchSelectorClass
+HildonTouchSelectorPrivate
 </SECTION>
 
 <SECTION>
@@ -955,7 +960,6 @@ HildonColorChooserClass
 
 <SECTION>
 <FILE>hildon-time-selector</FILE>
-HildonTimeSelectorPrivate
 <TITLE>HildonTimeSelector</TITLE>
 HildonTimeSelector
 hildon_time_selector_new
@@ -970,6 +974,7 @@ HILDON_TIME_SELECTOR_CLASS
 HILDON_IS_TIME_SELECTOR_CLASS
 HILDON_TIME_SELECTOR_GET_CLASS
 HildonTimeSelectorClass
+HildonTimeSelectorPrivate
 </SECTION>
 
 <SECTION>
@@ -1141,36 +1146,37 @@ hildon_play_system_sound
 
 <SECTION>
 <FILE>hildon-enum-types</FILE>
-hildon_caption_status_get_type
 HILDON_TYPE_CAPTION_STATUS
-hildon_caption_icon_position_get_type
 HILDON_TYPE_CAPTION_ICON_POSITION
-hildon_note_type_get_type
 HILDON_TYPE_NOTE_TYPE
-hildon_number_editor_error_type_get_type
 HILDON_TYPE_NUMBER_EDITOR_ERROR_TYPE
-hildon_date_time_error_get_type
 HILDON_TYPE_DATE_TIME_ERROR
-hildon_touch_selector_selection_mode_get_type
 HILDON_TYPE_TOUCH_SELECTOR_SELECTION_MODE
-hildon_window_clipboard_operation_get_type
 HILDON_TYPE_WINDOW_CLIPBOARD_OPERATION
-hildon_wizard_dialog_response_get_type
 HILDON_TYPE_WIZARD_DIALOG_RESPONSE
-hildon_calendar_display_options_get_type
 HILDON_TYPE_CALENDAR_DISPLAY_OPTIONS
-hildon_pannable_area_mode_get_type
 HILDON_TYPE_PANNABLE_AREA_MODE
-hildon_movement_mode_get_type
 HILDON_TYPE_MOVEMENT_MODE
-hildon_movement_direction_get_type
 HILDON_TYPE_MOVEMENT_DIRECTION
-hildon_size_request_policy_get_type
 HILDON_TYPE_SIZE_REQUEST_POLICY
-hildon_button_arrangement_get_type
 HILDON_TYPE_BUTTON_ARRANGEMENT
-hildon_button_style_get_type
 HILDON_TYPE_BUTTON_STYLE
+<SUBSECTION Standard>
+hildon_caption_status_get_type
+hildon_caption_icon_position_get_type
+hildon_note_type_get_type
+hildon_number_editor_error_type_get_type
+hildon_date_time_error_get_type
+hildon_touch_selector_selection_mode_get_type
+hildon_window_clipboard_operation_get_type
+hildon_wizard_dialog_response_get_type
+hildon_calendar_display_options_get_type
+hildon_pannable_area_mode_get_type
+hildon_movement_mode_get_type
+hildon_movement_direction_get_type
+hildon_size_request_policy_get_type
+hildon_button_arrangement_get_type
+hildon_button_style_get_type
 </SECTION>
 
 <SECTION>

diff --git a/src/hildon-caption.c b/src/hildon-caption.c
index 09f64e3..3e92b81 100644 (file)
--- a/src/hildon-caption.c
+++ b/src/hildon-caption.c
@@ -150,7 +150,7 @@ enum
  *
  * Initializes and returns the type of a hildon caption.
  *
- * @Returns: GType of #HildonCaption
+ * Returns: GType of #HildonCaption
  */
 GType G_GNUC_CONST 
 hildon_caption_get_type                         (void)
@@ -838,7 +838,7 @@ hildon_caption_set_size_group                   (const HildonCaption *self,
  *
  * Query given captioned control for the #GtkSizeGroup assigned to it.
  *
- * @Returns : a #GtkSizeGroup
+ * Returns: a #GtkSizeGroup
  * 
  */
 GtkSizeGroup*
@@ -871,7 +871,7 @@ hildon_caption_get_size_group                   (const HildonCaption *self)
  * The default behaviour for the caption's activate signal is to call   
  * gtk_widget_activate on it's control.
  * 
- * @Returns : a #GtkWidget pointer of Caption
+ * Returns: a #GtkWidget pointer of Caption
  */
 GtkWidget*
 hildon_caption_new                              (GtkSizeGroup *group, 
@@ -904,7 +904,7 @@ hildon_caption_new                              (GtkSizeGroup *group,
  * 
  * Query #HildonCaption whether this captioned control is a mandatory one.
  *
- * @Returns : is this captioned control a mandatory one?
+ * Returns: is this captioned control a mandatory one?
  */
 gboolean 
 hildon_caption_is_mandatory                     (const HildonCaption *caption)
@@ -949,7 +949,7 @@ hildon_caption_set_icon_position                (HildonCaption *caption,
  *
  * Gets #HildonCaption icon position.
  *
- * @Returns : one of the values from #HildonCaptionIconPosition.
+ * Returns: one of the values from #HildonCaptionIconPosition.
  *
  */
 
@@ -982,11 +982,11 @@ hildon_caption_set_status                       (HildonCaption *caption,
 
 /**
  * hildon_caption_get_status:
- * @caption : a #HildonCaption
+ * @caption: a #HildonCaption
  *
  * Gets #HildonCaption status.
  *
- * @Returns : one of the values from #HildonCaptionStatus
+ * Returns: one of the values from #HildonCaptionStatus
  */
 HildonCaptionStatus 
 hildon_caption_get_status                       (const HildonCaption *caption)
@@ -1023,7 +1023,7 @@ hildon_caption_set_icon_image                   (HildonCaption *caption,
  *
  * Gets icon of #HildonCaption
  *
- * @Returns : the #GtkImage widget that is being used as the icon by the
+ * Returns: the #GtkImage widget that is being used as the icon by the
  *            hildon_caption, or NULL if no icon image is in use.
  */
 GtkWidget*
@@ -1081,7 +1081,7 @@ hildon_caption_set_label_markup                 (HildonCaption *caption,
  *
  * Gets label of #HildonCaption
  * 
- * @Returns : the text currently being used as the label of the caption
+ * Returns: the text currently being used as the label of the caption
  *  control. The string is owned by the label and the caller should never 
  *  free or modify this value.
  */
@@ -1120,7 +1120,7 @@ hildon_caption_set_separator                    (HildonCaption *caption,
  *
  * Gets separator string of #HildonCaption
  *
- * @Returns : the text currently being used as the separator of the caption
+ * Returns: the text currently being used as the separator of the caption
  *  control. The string is owned by the caption control and the caller should
  *  never free or modify this value.   
  */
@@ -1197,7 +1197,7 @@ hildon_caption_set_child_expand                 (HildonCaption *caption,
  *
  * Gets childs expandability.
  *
- * @Returns : wheter the child is expandable or not.
+ * Returns: wheter the child is expandable or not.
  */
 gboolean 
 hildon_caption_get_child_expand                 (const HildonCaption *caption)

diff --git a/src/hildon-code-dialog.c b/src/hildon-code-dialog.c
index f700ad6..670c2a6 100644 (file)
--- a/src/hildon-code-dialog.c
+++ b/src/hildon-code-dialog.c
@@ -122,7 +122,7 @@ static guint                                    input_signal;
  *
  * Initializes and returns the type of a hildon code dialog.
  *
- * @Returns: GType of #HildonCodeDialog
+ * Returns: GType of #HildonCodeDialog
  */
 GType G_GNUC_CONST
 hildon_code_dialog_get_type                     (void)

diff --git a/src/hildon-color-button.c b/src/hildon-color-button.c
index 2776c3b..3fa180d 100644 (file)
--- a/src/hildon-color-button.c
+++ b/src/hildon-color-button.c
@@ -155,7 +155,7 @@ static guint                                    signals [LAST_SIGNAL] = { 0, };
  *
  * Initializes and returns the type of a hildon color button.
  *
- * @Returns: GType of #HildonColorButton.
+ * Returns: GType of #HildonColorButton.
  */
 GType G_GNUC_CONST
 hildon_color_button_get_type                    (void)

diff --git a/src/hildon-controlbar.c b/src/hildon-controlbar.c
index 7d9d184..15b8e00 100644 (file)
--- a/src/hildon-controlbar.c
+++ b/src/hildon-controlbar.c
@@ -156,7 +156,7 @@ hildon_controlbar_change_value                  (GtkRange *range,
  *
  * Initializes and returns the type of a hildon control bar.
  *
- * @Returns: GType of #HildonControlbar
+ * Returns: GType of #HildonControlbar
  */
 GType G_GNUC_CONST
 hildon_controlbar_get_type                      (void)

diff --git a/src/hildon-date-editor.c b/src/hildon-date-editor.c
index 23c3e31..d3c13a2 100644 (file)
--- a/src/hildon-date-editor.c
+++ b/src/hildon-date-editor.c
@@ -206,7 +206,7 @@ static guint                                    date_editor_signals[LAST_SIGNAL]
  *
  * Initializes and returns the type of a hildon date editor.
  *
- * @Returns: GType of #HildonDateEditor
+ * Returns: GType of #HildonDateEditor
  */
 GType G_GNUC_CONST
 hildon_date_editor_get_type                     (void)

diff --git a/src/hildon-date-selector.c b/src/hildon-date-selector.c
index beb2552..16b9709 100644 (file)
--- a/src/hildon-date-selector.c
+++ b/src/hildon-date-selector.c
@@ -619,6 +619,8 @@ hildon_date_selector_new ()
  * Sets the current active date on the #HildonDateSelector widget
  *
  * Since: 2.2
+ *
+ * Returns: %TRUE on success, %FALSE otherwise
  **/
 gboolean
 hildon_date_selector_select_current_date (HildonDateSelector * selector,
@@ -718,7 +720,9 @@ hildon_date_selector_get_date (HildonDateSelector * selector,
  * Utility function, too keep this API more similar to the previously existing
  * hildon-calendar widget.
  *
- * Since: 2.2 
+ * Since: 2.2
+ *
+ * Returns: %TRUE on success, %FALSE otherwise
  **/
 gboolean hildon_date_selector_select_month (HildonDateSelector *selector,
                                             guint month, guint year)

diff --git a/src/hildon-edit-toolbar.c b/src/hildon-edit-toolbar.c
index 614ac8b..56040bc 100644 (file)
--- a/src/hildon-edit-toolbar.c
+++ b/src/hildon-edit-toolbar.c
@@ -227,6 +227,8 @@ hildon_edit_toolbar_new                         (void)
 
 /**
  * hildon_edit_toolbar_new_with_text:
+ * @label: Text for the toolbar label.
+ * @button: Text for the toolbar button.
  *
  * Creates a new #HildonEditToolbar, with the toolbar label set to
  * @label and the button label set to @button.

diff --git a/src/hildon-find-toolbar.c b/src/hildon-find-toolbar.c
index 0daa472..f0bbd60 100644 (file)
--- a/src/hildon-find-toolbar.c
+++ b/src/hildon-find-toolbar.c
@@ -148,7 +148,7 @@ static guint                                    HildonFindToolbar_signal [LAST_S
  *
  * Initializes and returns the type of a hildon fond toolbar.
  *
- * @Returns: GType of #HildonFindToolbar
+ * Returns: GType of #HildonFindToolbar
  */
 GType G_GNUC_CONST
 hildon_find_toolbar_get_type                    (void)

diff --git a/src/hildon-font-selection-dialog.c b/src/hildon-font-selection-dialog.c
index b65ad8d..4635d4b 100644 (file)
--- a/src/hildon-font-selection-dialog.c
+++ b/src/hildon-font-selection-dialog.c
@@ -170,7 +170,7 @@ static GtkDialogClass*                          parent_class = NULL;
  *
  * Initializes and returns the type of a hildon font selection dialog
  *
- * @Returns: GType of #HildonFontSelectionDialog
+ * Returns: GType of #HildonFontSelectionDialog
  */
 GType G_GNUC_CONST
 hildon_font_selection_dialog_get_type           (void)

diff --git a/src/hildon-gtk.c b/src/hildon-gtk.c
index 9b44c00..274e9c4 100644 (file)
--- a/src/hildon-gtk.c
+++ b/src/hildon-gtk.c
@@ -311,7 +311,6 @@ hildon_gtk_window_set_progress_indicator        (GtkWindow    *window,
 
 /**
  * hildon_gtk_hscale_new:
- * @void: 
  *
  * Creates a new horizontal scale widget that lets the user select
  * a value. The value is technically a double between 0.0 and 1.0.
@@ -341,7 +340,6 @@ hildon_gtk_hscale_new                           (void)
 
 /**
  * hildon_gtk_vscale_new:
- * @void: 
  *
  * Creates a new vertical scale widget that lets the user select
  * a value. The value is technically a double between 0.0 and 1.0.

diff --git a/src/hildon-program.c b/src/hildon-program.c
index 963c697..1f9b4eb 100644 (file)
--- a/src/hildon-program.c
+++ b/src/hildon-program.c
@@ -269,6 +269,8 @@ hildon_program_get_property                     (GObject *object,
  * hildon_program_pop_window_stack:
  * @self: A #HildonProgram
  *
+ * Pops a window from the stack.
+ *
  * Deprecated: Use hildon_window_stack_pop() instead
  *
  * Returns: A #HildonStackableWindow, or %NULL
@@ -802,6 +804,8 @@ hildon_program_get_is_topmost                   (HildonProgram *self)
  * hildon_program_go_to_root_window:
  * @self: A #HildonProgram
  *
+ * Goes to the root window of the stack.
+ *
  * Deprecated: See #HildonWindowStack
  */
 void

diff --git a/src/hildon-range-editor.c b/src/hildon-range-editor.c
index 13ec2f9..804b9fc 100644 (file)
--- a/src/hildon-range-editor.c
+++ b/src/hildon-range-editor.c
@@ -802,7 +802,7 @@ hildon_range_editor_refresh_widths              (HildonRangeEditorPrivate *priv)
  * 
  * Initializes, and returns the type of a hildon range editor.
  * 
- * @Returns : GType of #HildonRangeEditor
+ * Returns: GType of #HildonRangeEditor
  * 
  */
 GType G_GNUC_CONST

diff --git a/src/hildon-seekbar.c b/src/hildon-seekbar.c
index e4545d1..f80b24a 100644 (file)
--- a/src/hildon-seekbar.c
+++ b/src/hildon-seekbar.c
@@ -129,7 +129,7 @@ enum
  * 
  * Initializes, and returns the type of a hildon seekbar.
  * 
- * @Returns : GType of #HildonSeekbar
+ * Returns: GType of #HildonSeekbar
  * 
  */
 GType G_GNUC_CONST 

diff --git a/src/hildon-time-editor.c b/src/hildon-time-editor.c
index a1e4e38..114af7c 100644 (file)
--- a/src/hildon-time-editor.c
+++ b/src/hildon-time-editor.c
@@ -277,7 +277,7 @@ hildon_time_editor_inserted_text                (GtkEditable *editable,
  *
  * Initializes and returns the type of a hildon time editor.
  *
- * @Returns: GType of #HildonTimeEditor
+ * Returns: GType of #HildonTimeEditor
  */
 GType G_GNUC_CONST
 hildon_time_editor_get_type                     (void)

diff --git a/src/hildon-time-selector.c b/src/hildon-time-selector.c
index 05334ce..1afb632 100644 (file)
--- a/src/hildon-time-selector.c
+++ b/src/hildon-time-selector.c
@@ -406,6 +406,8 @@ hildon_time_selector_new ()
  * (0-23):(0-59).
  *
  * Since: 2.2
+ *
+ * Returns: %TRUE on success, %FALSE otherwise
  **/
 gboolean
 hildon_time_selector_set_time (HildonTimeSelector * selector,

diff --git a/src/hildon-volumebar-range.c b/src/hildon-volumebar-range.c
index f88a6ee..0999e73 100644 (file)
--- a/src/hildon-volumebar-range.c
+++ b/src/hildon-volumebar-range.c
@@ -98,7 +98,7 @@ enum
  *
  * Initializes and returns the type of a hildon volumebar range.
  *
- * @Returns: GType of #HildonVolumebarRange
+ * Returns: GType of #HildonVolumebarRange
  */
 GType G_GNUC_CONST
 hildon_volumebar_range_get_type                 (void)

diff --git a/src/hildon-volumebar.c b/src/hildon-volumebar.c
index e2d49d7..38876b0 100644 (file)
--- a/src/hildon-volumebar.c
+++ b/src/hildon-volumebar.c
@@ -127,7 +127,7 @@ static guint                                    signals [LAST_SIGNAL] = { 0 };
  *
  * Initializes and returns the type of a hildon volumebar.
  *
- * @Returns: GType of #HildonVolumebar
+ * Returns: GType of #HildonVolumebar
  */
 GType G_GNUC_CONST 
 hildon_volumebar_get_type                       (void)

diff --git a/src/hildon-vvolumebar.c b/src/hildon-vvolumebar.c
index 34fd06d..d71193a 100644 (file)
--- a/src/hildon-vvolumebar.c
+++ b/src/hildon-vvolumebar.c
@@ -97,7 +97,7 @@ hildon_vvolumebar_size_allocate                 (GtkWidget * widget,
  *
  * Initializes and returns the type of a hildon vvolumebar.
  *
- * @Returns: GType of #HildonVVolumebar
+ * Returns: GType of #HildonVVolumebar
  */
 GType G_GNUC_CONST
 hildon_vvolumebar_get_type                      (void)

diff --git a/src/hildon-weekday-picker.c b/src/hildon-weekday-picker.c
index 901ab32..e66f6cb 100644 (file)
--- a/src/hildon-weekday-picker.c
+++ b/src/hildon-weekday-picker.c
@@ -120,7 +120,7 @@ static guint                                    signals [LAST_SIGNAL] = { 0 } ;
  *
  * Initializes and returns the type of a hildon weekday picker.
  *
- * @Returns: GType of #HildonWeekdayPicker
+ * Returns: GType of #HildonWeekdayPicker
  */
 GType G_GNUC_CONST
 hildon_weekday_picker_get_type                  (void)

diff --git a/src/hildon-window.c b/src/hildon-window.c
index 038ee9d..81af472 100644 (file)
--- a/src/hildon-window.c
+++ b/src/hildon-window.c
@@ -1778,9 +1778,11 @@ hildon_window_set_menu                          (HildonWindow *self,
 /**
  * hildon_window_get_is_topmost:
  * @self: A #HildonWindow
- * 
- * Return value: Whether or not the #HildonWindow is currenltly activated
- * by the window manager.
+ *
+ * Returns whether the #HildonWindow is currenty activated by the
+ * window manager.
+ *
+ * Return value: %TRUE if @self is currently activated, %FALSE otherwise.
  **/
 gboolean
 hildon_window_get_is_topmost                    (HildonWindow *self)

diff --git a/src/hildon-wizard-dialog.c b/src/hildon-wizard-dialog.c
index 7acd00e..8090e5e 100644 (file)
--- a/src/hildon-wizard-dialog.c
+++ b/src/hildon-wizard-dialog.c
@@ -107,7 +107,7 @@ enum
  *
  * Initializes and returns the type of a hildon wizard dialog.
  *
- * @Returns: GType of #HildonWzardDialog
+ * Returns: GType of #HildonWzardDialog
  */
 GType G_GNUC_CONST
 hildon_wizard_dialog_get_type                   (void)