[gtk+] More documentation fixes



commit 6aa56979dc28c8e1bb87b081f4307bbcb670c231
Author: Matthias Clasen <mclasen redhat com>
Date:   Tue Sep 17 01:28:39 2013 -0400

    More documentation fixes

 docs/reference/gtk/gtk3-sections.txt |    3 +++
 gtk/gtkicontheme.c                   |    4 ++--
 gtk/gtkplacessidebar.c               |   27 +++++++++++++++++++++++----
 gtk/gtkrevealer.c                    |    9 +++++++++
 gtk/gtkwidget.c                      |    2 +-
 5 files changed, 38 insertions(+), 7 deletions(-)
---
diff --git a/docs/reference/gtk/gtk3-sections.txt b/docs/reference/gtk/gtk3-sections.txt
index 531f05e..27bb480 100644
--- a/docs/reference/gtk/gtk3-sections.txt
+++ b/docs/reference/gtk/gtk3-sections.txt
@@ -5282,6 +5282,7 @@ gtk_widget_queue_draw
 gtk_widget_queue_resize
 gtk_widget_queue_resize_no_redraw
 gtk_widget_get_frame_clock
+gtk_widget_get_scale_factor
 GtkTickCallback
 gtk_widget_add_tick_callback
 gtk_widget_remove_tick_callback
@@ -6636,6 +6637,7 @@ gtk_icon_theme_lookup_icon_for_scale
 gtk_icon_theme_choose_icon
 gtk_icon_theme_choose_icon_for_scale
 gtk_icon_theme_lookup_by_gicon
+gtk_icon_theme_lookup_by_gicon_for_scale
 gtk_icon_theme_load_icon
 gtk_icon_theme_load_icon_for_scale
 gtk_icon_theme_load_surface
@@ -6705,6 +6707,7 @@ gtk_icon_set_new_from_pixbuf
 gtk_icon_set_ref
 gtk_icon_set_render_icon
 gtk_icon_set_render_icon_pixbuf
+gtk_icon_set_render_icon_surface
 gtk_icon_set_unref
 gtk_icon_size_lookup
 gtk_icon_size_lookup_for_settings
diff --git a/gtk/gtkicontheme.c b/gtk/gtkicontheme.c
index 2ce68fd..e9c9838 100644
--- a/gtk/gtkicontheme.c
+++ b/gtk/gtkicontheme.c
@@ -5200,8 +5200,8 @@ gtk_icon_theme_lookup_by_gicon (GtkIconTheme       *icon_theme,
  * The icon can then be rendered into a pixbuf using
  * gtk_icon_info_load_icon_for_scale ().
  *
- * Return value: (transfer full): a #GtkIconInfo structure containing 
- *     information about the icon, or %NULL if the icon 
+ * Return value: (transfer full): a #GtkIconInfo structure containing
+ *     information about the icon, or %NULL if the icon
  *     wasn't found. Unref with g_object_unref()
  *
  * Since: 3.10
diff --git a/gtk/gtkplacessidebar.c b/gtk/gtkplacessidebar.c
index da6592e..7e84cb4 100644
--- a/gtk/gtkplacessidebar.c
+++ b/gtk/gtkplacessidebar.c
@@ -4207,9 +4207,15 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class)
 /**
  * gtk_places_sidebar_new:
  *
- * Creates a new #GtkPlacesSidebar widget.  The application should connect
- * to at least the #GtkPlacesSidebar::open-location signal to be notified
+ * Creates a new #GtkPlacesSidebar widget.
+ *
+ * The application should connect to at least the
+ * #GtkPlacesSidebar::open-location signal to be notified
  * when the user makes a selection in the sidebar.
+ *
+ * Returns: a newly created #GtkPlacesSidebar
+ *
+ * Since: 3.10
  */
 GtkWidget *
 gtk_places_sidebar_new (void)
@@ -4332,6 +4338,16 @@ gtk_places_sidebar_set_open_flags (GtkPlacesSidebar *sidebar, GtkPlacesOpenFlags
        }
 }
 
+/**
+ * gtk_places_sidebar_get_open_flags:
+ * @sidebar: a #GtkPlacesSidebar
+ *
+ * Gets the open flags.
+ *
+ * Returns: the #GtkPlacesOpenFlags of @sidebar
+ *
+ * Since: 3.10
+ */
 GtkPlacesOpenFlags
 gtk_places_sidebar_get_open_flags (GtkPlacesSidebar *sidebar)
 {
@@ -4602,8 +4618,11 @@ gtk_places_sidebar_remove_shortcut (GtkPlacesSidebar *sidebar, GFile *location)
  * gtk_places_sidebar_list_shortcuts:
  * @sidebar: a places sidebar
  *
- * Return value: (element-type GFile) (transfer full): A #GSList of #GFile of the locations
- * that have been added as application-specific shortcuts with gtk_places_sidebar_add_shortcut().
+ * Gets the list of shortcuts.
+ *
+ * Return value: (element-type GFile) (transfer full):
+ *     A #GSList of #GFile of the locations that have been added as
+ *     application-specific shortcuts with gtk_places_sidebar_add_shortcut().
  * To free this list, you can use
  * |[
  * g_slist_free_full (list, (GDestroyNotify) g_object_unref);
diff --git a/gtk/gtkrevealer.c b/gtk/gtkrevealer.c
index f90479e..09718f3 100644
--- a/gtk/gtkrevealer.c
+++ b/gtk/gtkrevealer.c
@@ -249,6 +249,15 @@ gtk_revealer_class_init (GtkRevealerClass *klass)
                                                          G_PARAM_READABLE));
 }
 
+/**
+ * gtk_revealer_new:
+ *
+ * Creates a new #GtkRevealer.
+ *
+ * Returns: a newly created #GtkRevealer
+ *
+ * Since: 3.10
+ */
 GtkWidget *
 gtk_revealer_new (void)
 {
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index 532a828..c49fb57 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -15932,7 +15932,7 @@ gtk_widget_class_set_connect_func (GtkWidgetClass        *widget_class,
 }
 
 /**
- * gtk_widget_class_bind_template_child_private_full:
+ * gtk_widget_class_bind_template_child_full:
  * @widget_class: A #GtkWidgetClass
  * @name: The "id" of the child defined in the template XML
  * @internal_child: Whether the child should be accessible as an "internal-child"


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