[gtk+] Documentation fixes



commit ca40ad1b1a1079736259a011f1ea414124d5b4a3
Author: Matthias Clasen <mclasen redhat com>
Date:   Tue Sep 17 01:13:03 2013 -0400

    Documentation fixes

 docs/reference/gdk/gdk3-sections.txt |    3 +--
 gdk/gdkcairo.c                       |    8 +++++---
 gdk/gdkdnd.c                         |    2 ++
 gdk/gdkwindow.c                      |    6 +++---
 gdk/x11/gdkwindow-x11.c              |   10 ++++++++++
 5 files changed, 21 insertions(+), 8 deletions(-)
---
diff --git a/docs/reference/gdk/gdk3-sections.txt b/docs/reference/gdk/gdk3-sections.txt
index ebfc9d1..dc0413d 100644
--- a/docs/reference/gdk/gdk3-sections.txt
+++ b/docs/reference/gdk/gdk3-sections.txt
@@ -809,9 +809,8 @@ gdk_event_get_scroll_direction
 gdk_event_get_scroll_deltas
 gdk_event_get_state
 gdk_event_get_time
-gdk_event_get_event_type
 gdk_event_get_window
-gdk_event_get_type
+gdk_event_get_event_type
 GdkEventSequence
 gdk_event_get_event_sequence
 gdk_event_request_motions
diff --git a/gdk/gdkcairo.c b/gdk/gdkcairo.c
index 67fc35a..5dba69a 100644
--- a/gdk/gdkcairo.c
+++ b/gdk/gdkcairo.c
@@ -157,7 +157,7 @@ gdk_cairo_rectangle (cairo_t            *cr,
  * Since: 2.8
  */
 void
-gdk_cairo_region (cairo_t         *cr,
+gdk_cairo_region (cairo_t              *cr,
                   const cairo_region_t *region)
 {
   cairo_rectangle_int_t box;
@@ -184,12 +184,14 @@ gdk_cairo_region (cairo_t         *cr,
  * Creates an image surface with the same contents as
  * the pixbuf.
  *
+ * Returns: a new cairo surface, must be freed with cairo_surface_destroy()
+ *
  * Since: 3.10
  */
 cairo_surface_t *
 gdk_cairo_surface_create_from_pixbuf (const GdkPixbuf *pixbuf,
-                                      int scale,
-                                      GdkWindow *for_window)
+                                      int              scale,
+                                      GdkWindow       *for_window)
 {
   gint width = gdk_pixbuf_get_width (pixbuf);
   gint height = gdk_pixbuf_get_height (pixbuf);
diff --git a/gdk/gdkdnd.c b/gdk/gdkdnd.c
index 1614a39..559a31d 100644
--- a/gdk/gdkdnd.c
+++ b/gdk/gdkdnd.c
@@ -315,6 +315,8 @@ gdk_drag_status (GdkDragContext *context,
  * set of actions changes.
  *
  * This function is called by the drag source.
+ *
+ * Returns:
  */
 gboolean
 gdk_drag_motion (GdkDragContext *context,
diff --git a/gdk/gdkwindow.c b/gdk/gdkwindow.c
index a07d3b4..f096101 100644
--- a/gdk/gdkwindow.c
+++ b/gdk/gdkwindow.c
@@ -2422,10 +2422,10 @@ gdk_window_peek_children (GdkWindow *window)
 /**
  * gdk_window_get_children_with_user_data:
  * @window: a #GdkWindow
- * @user_data: 
+ * @user_data: user data to look for
  *
- * Gets the list of children of @window known to GDK with a particular
- * @user_data set on it.
+ * Gets the list of children of @window known to GDK with a
+ * particular @user_data set on it.
  *
  * The returned list must be freed, but the elements in the
  * list need not be.
diff --git a/gdk/x11/gdkwindow-x11.c b/gdk/x11/gdkwindow-x11.c
index b11909f..a5c4507 100644
--- a/gdk/x11/gdkwindow-x11.c
+++ b/gdk/x11/gdkwindow-x11.c
@@ -2156,6 +2156,16 @@ get_netwm_cardinal_property (GdkWindow   *window,
   return prop;
 }
 
+/**
+ * gdk_x11_window_get_desktop:
+ * @window: a #GdkWindow
+ *
+ * Gets the number of the workspace @window is on.
+ *
+ * Returns: the current workspace of @window
+ *
+ * Since: 3.10
+ */
 guint32
 gdk_x11_window_get_desktop (GdkWindow *window)
 {


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