[gtk+] docs: avoid ambiguous return tags



commit 0a416c7559ff13b729d21da68298b342fa80a8a7
Author: William Jon McCann <william jon mccann gmail com>
Date:   Mon Jan 20 19:15:34 2014 -0500

    docs: avoid ambiguous return tags

 gtk/deprecated/gtkstyle.h |    2 +-
 gtk/gtkheaderbar.c        |    2 +-
 gtk/gtkicontheme.h        |    2 +-
 gtk/gtkmenutrackeritem.c  |    4 ++--
 4 files changed, 5 insertions(+), 5 deletions(-)
---
diff --git a/gtk/deprecated/gtkstyle.h b/gtk/deprecated/gtkstyle.h
index d5bf9d7..4239e67 100644
--- a/gtk/deprecated/gtkstyle.h
+++ b/gtk/deprecated/gtkstyle.h
@@ -55,7 +55,7 @@ typedef struct _GtkRcProperty  GtkRcProperty;
  * GTK_STYLE_ATTACHED:
  * @style: a #GtkStyle.
  *
- * Returns whether the style is attached to a window.
+ * Returns: whether the style is attached to a window.
  */
 #define GTK_STYLE_ATTACHED(style)       (GTK_STYLE (style)->attach_count > 0)
 
diff --git a/gtk/gtkheaderbar.c b/gtk/gtkheaderbar.c
index 9626184..1289f16 100644
--- a/gtk/gtkheaderbar.c
+++ b/gtk/gtkheaderbar.c
@@ -2043,7 +2043,7 @@ gtk_header_bar_set_has_subtitle (GtkHeaderBar *bar,
  * gtk_header_bar_get_has_subtitle:
  * @bar: a #GtkHeaderBar
  *
- * Returns whether the header bar reserves space
+ * Returns: %TRUE if the header bar reserves space
  * for a subtitle.
  *
  * Since: 3.12
diff --git a/gtk/gtkicontheme.h b/gtk/gtkicontheme.h
index cb1368a..6ae42b5 100644
--- a/gtk/gtkicontheme.h
+++ b/gtk/gtkicontheme.h
@@ -111,7 +111,7 @@ struct _GtkIconThemeClass
  * @GTK_ICON_LOOKUP_GENERIC_FALLBACK: Try to shorten icon name at '-'
  *   characters before looking at inherited themes. For more general
  *   fallback, see gtk_icon_theme_choose_icon(). Since 2.12.
- * @GTK_ICON_LOOKUP_FORCE_SIZE: Always return the icon scaled to the
+ * @GTK_ICON_LOOKUP_FORCE_SIZE: Always get the icon scaled to the
  *   requested size. Since 2.14.
  * 
  * Used to specify options for gtk_icon_theme_lookup_icon()
diff --git a/gtk/gtkmenutrackeritem.c b/gtk/gtkmenutrackeritem.c
index ddcbc0b..d944e96 100644
--- a/gtk/gtkmenutrackeritem.c
+++ b/gtk/gtkmenutrackeritem.c
@@ -546,7 +546,7 @@ _gtk_menu_tracker_item_get_observable (GtkMenuTrackerItem *self)
  * gtk_menu_tracker_item_get_is_separator:
  * @self: A #GtkMenuTrackerItem instance
  *
- * Returns whether the menu item is a separator. If so, only
+ * Returns: whether the menu item is a separator. If so, only
  * certain properties may need to be obeyed. See the documentation
  * for #GtkMenuTrackerItem.
  */
@@ -560,7 +560,7 @@ gtk_menu_tracker_item_get_is_separator (GtkMenuTrackerItem *self)
  * gtk_menu_tracker_item_get_has_submenu:
  * @self: A #GtkMenuTrackerItem instance
  *
- * Returns whether the menu item has a submenu. If so, only
+ * Returns: whether the menu item has a submenu. If so, only
  * certain properties may need to be obeyed. See the documentation
  * for #GtkMenuTrackerItem.
  */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]