[gtk+] Fix up parameter mismatches in the docs



commit 17e2c5391cdf70f956383d518f0c63a98c425ca1
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Dec 3 08:50:05 2010 -0500

    Fix up parameter mismatches in the docs
    
    And other minor gdk doc fixes.

 docs/reference/gdk/gdk3-sections.txt |   14 ++++++++++----
 gdk/gdkcairo.c                       |   11 ++++++++++-
 gdk/gdkwindow.c                      |    2 +-
 gdk/x11/gdkkeys-x11.c                |    5 ++---
 gdk/x11/gdkx.h                       |    2 ++
 5 files changed, 25 insertions(+), 9 deletions(-)
---
diff --git a/docs/reference/gdk/gdk3-sections.txt b/docs/reference/gdk/gdk3-sections.txt
index 32bf9cf..7b58029 100644
--- a/docs/reference/gdk/gdk3-sections.txt
+++ b/docs/reference/gdk/gdk3-sections.txt
@@ -257,6 +257,8 @@ gdk_color_to_string
 <SUBSECTION Standard>
 GDK_TYPE_COLOR
 
+<SUBSECTION Private>
+gdk_color_get_type
 </SECTION>
 
 <SECTION>
@@ -272,6 +274,9 @@ gdk_rgba_to_string
 
 <SUBSECTION Standard>
 GDK_TYPE_RGBA
+
+<SUBSECTION Private>
+gdk_rgba_get_type
 </SECTION>
 
 <SECTION>
@@ -312,6 +317,7 @@ GDK_VISUAL_GET_CLASS
 
 <SUBSECTION Private>
 GdkVisualClass
+GdkVisualPrivate
 gdk_visual_get_type
 </SECTION>
 
@@ -382,6 +388,7 @@ gdk_window_get_clip_region
 gdk_window_begin_paint_rect
 gdk_window_begin_paint_region
 gdk_window_end_paint
+gdk_window_get_visible_region
 
 <SUBSECTION>
 gdk_window_invalidate_rect
@@ -511,7 +518,7 @@ gdk_drawable_get_type
 GdkWindowObject
 GdkWindowObjectClass
 GdkWindowImpl
-GdkWindowImplIface
+GdkWindowImplClass
 GdkWindowRedirect
 gdk_window_impl_get_type
 gdk_window_freeze_toplevel_updates_libgtk_only
@@ -714,6 +721,7 @@ gdk_device_get_device_type
 gdk_device_get_display
 gdk_device_get_has_cursor
 gdk_device_get_n_axes
+gdk_device_get_n_keys
 
 <SUBSECTION>
 gdk_device_grab
@@ -946,11 +954,8 @@ gdk_drag_context_get_type
 <TITLE>X Window System Interaction</TITLE>
 <FILE>x_interaction</FILE>
 GDK_ROOT_WINDOW
-GDK_WINDOW_XDISPLAY
 GDK_WINDOW_XID
 GDK_DISPLAY_XDISPLAY
-GDK_DRAWABLE_XDISPLAY
-GDK_DRAWABLE_XID
 GDK_SCREEN_XDISPLAY
 GDK_SCREEN_XNUMBER
 GDK_SCREEN_XSCREEN
@@ -977,6 +982,7 @@ gdk_x11_cursor_get_xcursor
 gdk_x11_cursor_get_xdisplay
 gdk_x11_display_broadcast_startup_message
 gdk_x11_display_get_startup_notification_id
+gdk_x11_display_set_startup_notification_id
 gdk_x11_display_get_xdisplay
 gdk_x11_display_grab
 gdk_x11_display_ungrab
diff --git a/gdk/gdkcairo.c b/gdk/gdkcairo.c
index 7160207..0d4b8bd 100644
--- a/gdk/gdkcairo.c
+++ b/gdk/gdkcairo.c
@@ -84,7 +84,7 @@ gdk_cairo_get_clip_rectangle (cairo_t      *cr,
  * gdk_cairo_set_source_color:
  * @cr: a #cairo_t
  * @color: a #GdkColor
- * 
+ *
  * Sets the specified #GdkColor as the source color of @cr.
  *
  * Since: 2.8
@@ -102,6 +102,15 @@ gdk_cairo_set_source_color (cairo_t        *cr,
 			color->blue / 65535.);
 }
 
+/**
+ * gdk_cairo_set_source_rgba:
+ * @cr: a #cairo_t
+ * @rgba: a #GdkRGBA
+ *
+ * Sets the specified #GdkRGBA as the source color of @cr.
+ *
+ * Since: 3.0
+ **/
 void
 gdk_cairo_set_source_rgba (cairo_t       *cr,
                            const GdkRGBA *rgba)
diff --git a/gdk/gdkwindow.c b/gdk/gdkwindow.c
index 7b89ab7..104ea41 100644
--- a/gdk/gdkwindow.c
+++ b/gdk/gdkwindow.c
@@ -3666,7 +3666,7 @@ _gdk_window_ref_cairo_surface (GdkWindow *window)
 
 /**
  * gdk_cairo_create:
- * @drawable: a #GdkWindow
+ * @window: a #GdkWindow
  * 
  * Creates a Cairo context for drawing to @window.
  *
diff --git a/gdk/x11/gdkkeys-x11.c b/gdk/x11/gdkkeys-x11.c
index 20bb6ee..1de8400 100644
--- a/gdk/x11/gdkkeys-x11.c
+++ b/gdk/x11/gdkkeys-x11.c
@@ -1609,14 +1609,13 @@ gdk_keymap_translate_keyboard_state (GdkKeymap       *keymap,
 /* Key handling not part of the keymap */
 /**
  * gdk_keyval_name:
+ * @keyval: a key value.
  *
  * Converts a key value into a symbolic name.
- * The names are the same as those in the 
+ * The names are the same as those in the
  * <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> header file
  * but without the leading "GDK_KEY_".
  *
- * @keyval: a key value.
- * 
  * Return value: (transfer none): a string containing the name of the key, or 
  * %NULL if @keyval is not a valid key. The string should not be modified.
  **/
diff --git a/gdk/x11/gdkx.h b/gdk/x11/gdkx.h
index 5db972c..51aae0d 100644
--- a/gdk/x11/gdkx.h
+++ b/gdk/x11/gdkx.h
@@ -106,6 +106,8 @@ gint     gdk_x11_get_default_screen       (void);
  * @display: a #GdkDisplay.
  *
  * Returns the display of a #GdkDisplay.
+ *
+ * Returns: an Xlib <type>Display*</type>
  */
 #define GDK_DISPLAY_XDISPLAY(display) (GDK_DISPLAY_X11(display)->xdisplay)
 



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