GNOME.org
 

[gtkglext] add missing gobject-introspection annotations

commit cde388e491d3cf26a09326acb13f83619fcf2bfc
Author: Anton Gorenko <ex rzrjck gmail com>
Date:   Tue Sep 28 00:07:19 2010 +0600

    add missing gobject-introspection annotations
    
    (cherry picked from commit f3175ae198816e5c5a80b9e8a1288dbf1de2f28c)
    Signed-off-by: Emmanuele Bassi <ebassi gnome org>

 gdk/gdkglcontext.c         |    2 +-
 gdk/gdkgldrawable.c        |    8 ++++----
 gdk/gdkglinit.c            |   12 ++++++------
 gdk/gdkglpixmap.c          |    8 ++++----
 gdk/gdkglwindow.c          |    8 ++++----
 gdk/x11/gdkglconfig-x11.c  |   16 ++++++++--------
 gdk/x11/gdkglcontext-x11.c |   10 +++++-----
 gdk/x11/gdkglpixmap-x11.c  |    2 +-
 gdk/x11/gdkglquery-x11.c   |   10 +++++-----
 gdk/x11/gdkglwindow-x11.c  |    2 +-
 gtk/gtkglinit.c            |   12 ++++++------
 gtk/gtkglwidget.c          |   12 ++++++------
 12 files changed, 51 insertions(+), 51 deletions(-)
---
diff --git a/gdk/gdkglcontext.c b/gdk/gdkglcontext.c
index acb8d64..621b103 100644
--- a/gdk/gdkglcontext.c
+++ b/gdk/gdkglcontext.c
@@ -47,7 +47,7 @@ gdk_gl_context_class_init (GdkGLContextClass *klass)
 /**
  * gdk_gl_context_new:
  * @gldrawable: a #GdkGLDrawable.
- * @share_list: the #GdkGLContext with which to share display lists and texture
+ * @share_list: (allow-none): the #GdkGLContext with which to share display lists and texture
  *              objects. NULL indicates that no sharing is to take place.
  * @direct: whether rendering is to be done with a direct connection to
  *          the graphics system.
diff --git a/gdk/gdkgldrawable.c b/gdk/gdkgldrawable.c
index 28db2a6..b74ef69 100644
--- a/gdk/gdkgldrawable.c
+++ b/gdk/gdkgldrawable.c
@@ -170,7 +170,7 @@ gdk_gl_drawable_gl_end (GdkGLDrawable *gldrawable)
  *
  * Gets #GdkGLConfig with which the @gldrawable is configured.
  *
- * Return value: the #GdkGLConfig.
+ * Return value: (transfer none): the #GdkGLConfig.
  **/
 GdkGLConfig *
 gdk_gl_drawable_get_gl_config (GdkGLDrawable *gldrawable)
@@ -183,8 +183,8 @@ gdk_gl_drawable_get_gl_config (GdkGLDrawable *gldrawable)
 /**
  * gdk_gl_drawable_get_size:
  * @gldrawable: a #GdkGLDrawable.
- * @width: location to store drawable's width, or NULL.
- * @height: location to store drawable's height, or NULL.
+ * @width: (out) (allow-none): location to store drawable's width, or NULL.
+ * @height: (out) (allow-none): location to store drawable's height, or NULL.
  *
  * Fills *width and *height with the size of GL drawable.
  * width or height can be NULL if you only want the other one.
@@ -205,7 +205,7 @@ gdk_gl_drawable_get_size (GdkGLDrawable *gldrawable,
  *
  * Returns the current #GdkGLDrawable.
  *
- * Return value: the current #GdkGLDrawable or NULL if there is no current drawable.
+ * Return value: (transfer none): the current #GdkGLDrawable or NULL if there is no current drawable.
  **/
 GdkGLDrawable *
 gdk_gl_drawable_get_current (void)
diff --git a/gdk/gdkglinit.c b/gdk/gdkglinit.c
index 4e91655..40aca90 100644
--- a/gdk/gdkglinit.c
+++ b/gdk/gdkglinit.c
@@ -44,8 +44,8 @@ static const guint gdk_gl_ndebug_keys = G_N_ELEMENTS (gdk_gl_debug_keys);
 
 /**
  * gdk_gl_parse_args:
- * @argc: the number of command line arguments.
- * @argv: the array of command line arguments.
+ * @argc: (inout): the number of command line arguments.
+ * @argv: (array length=argc) (inout) (allow-none): the array of command line arguments.
  *
  * Parses command line arguments, and initializes global
  * attributes of GdkGLExt.
@@ -176,10 +176,10 @@ gdk_gl_parse_args (int    *argc,
 
 /**
  * gdk_gl_init_check:
- * @argc: Address of the <parameter>argc</parameter> parameter of your
+ * @argc: (inout): Address of the <parameter>argc</parameter> parameter of your
  *        <function>main()</function> function. Changed if any arguments
  *        were handled.
- * @argv: Address of the <parameter>argv</parameter> parameter of
+ * @argv: (array length=argc) (inout) (allow-none): Address of the <parameter>argv</parameter> parameter of
  *        <function>main()</function>. Any parameters understood by
  *        gdk_gl_init() are stripped before return.
  *
@@ -212,9 +212,9 @@ gdk_gl_init_check (int    *argc,
 
 /**
  * gdk_gl_init:
- * @argc: Address of the <parameter>argc</parameter> parameter of your
+ * @argc: (inout): Address of the <parameter>argc</parameter> parameter of your
  * main() function. Changed if any arguments were handled.
- * @argv: Address of the <parameter>argv</parameter> parameter of
+ * @argv: (array length=argc) (inout) (allow-none): Address of the <parameter>argv</parameter> parameter of
  * main(). Any parameters understood by gdk_gl_init() are stripped
  * before return.
  *
diff --git a/gdk/gdkglpixmap.c b/gdk/gdkglpixmap.c
index 6de74a1..75af9e7 100644
--- a/gdk/gdkglpixmap.c
+++ b/gdk/gdkglpixmap.c
@@ -740,7 +740,7 @@ _gdk_gl_pixmap_get_size (GdkGLDrawable *gldrawable,
  * Notice that #GdkGLPixmap is not #GdkPixmap, but another
  * #GdkDrawable which have an associated #GdkPixmap.
  *
- * Return value: the #GdkPixmap associated with @glpixmap.
+ * Return value: (transfer none): the #GdkPixmap associated with @glpixmap.
  **/
 GdkPixmap *
 gdk_gl_pixmap_get_pixmap (GdkGLPixmap *glpixmap)
@@ -761,14 +761,14 @@ static GQuark quark_gl_pixmap = 0;
  * gdk_pixmap_set_gl_capability:
  * @pixmap: the #GdkPixmap to be used as the rendering area.
  * @glconfig: a #GdkGLConfig.
- * @attrib_list: this must be set to NULL or empty (first attribute of None).
+ * @attrib_list: (array) (allow-none): this must be set to NULL or empty (first attribute of None).
  *
  * Set the OpenGL-capability to the @pixmap.
  * This function creates a new #GdkGLPixmap held by the @pixmap.
  * attrib_list is currently unused. This must be set to NULL or empty
  * (first attribute of None).
  *
- * Return value: the #GdkGLPixmap used by the @pixmap if it is successful,
+ * Return value: (transfer none): the #GdkGLPixmap used by the @pixmap if it is successful,
  *               NULL otherwise.
  **/
 GdkGLPixmap *
@@ -861,7 +861,7 @@ gdk_pixmap_is_gl_capable (GdkPixmap *pixmap)
  *
  * Returns the #GdkGLPixmap held by the @pixmap.
  *
- * Return value: the #GdkGLPixmap.
+ * Return value: (transfer none): the #GdkGLPixmap.
  **/
 GdkGLPixmap *
 gdk_pixmap_get_gl_pixmap (GdkPixmap *pixmap)
diff --git a/gdk/gdkglwindow.c b/gdk/gdkglwindow.c
index 38e03c1..d4cc576 100644
--- a/gdk/gdkglwindow.c
+++ b/gdk/gdkglwindow.c
@@ -741,7 +741,7 @@ _gdk_gl_window_get_size (GdkGLDrawable *gldrawable,
  * Notice that #GdkGLWindow is not #GdkWindow, but another
  * #GdkDrawable which have an associated #GdkWindow.
  *
- * Return value: the #GdkWindow associated with @glwindow.
+ * Return value: (transfer none): the #GdkWindow associated with @glwindow.
  **/
 GdkWindow *
 gdk_gl_window_get_window (GdkGLWindow *glwindow)
@@ -762,14 +762,14 @@ static GQuark quark_gl_window = 0;
  * gdk_window_set_gl_capability:
  * @window: the #GdkWindow to be used as the rendering area.
  * @glconfig: a #GdkGLConfig.
- * @attrib_list: this must be set to NULL or empty (first attribute of None).
+ * @attrib_list: (array) (allow-none): this must be set to NULL or empty (first attribute of None).
  *
  * Set the OpenGL-capability to the @window.
  * This function creates a new #GdkGLWindow held by the @window.
  * attrib_list is currently unused. This must be set to NULL or empty
  * (first attribute of None).
  *
- * Return value: the #GdkGLWindow used by the @window if it is successful,
+ * Return value: (transfer none): the #GdkGLWindow used by the @window if it is successful,
  *               NULL otherwise.
  **/
 GdkGLWindow *
@@ -876,7 +876,7 @@ gdk_window_is_gl_capable (GdkWindow *window)
  *
  * Returns the #GdkGLWindow held by the @window.
  *
- * Return value: the #GdkGLWindow.
+ * Return value: (transfer none): the #GdkGLWindow.
  **/
 GdkGLWindow *
 gdk_window_get_gl_window (GdkWindow *window)
diff --git a/gdk/x11/gdkglconfig-x11.c b/gdk/x11/gdkglconfig-x11.c
index c47caf0..ee20f1a 100644
--- a/gdk/x11/gdkglconfig-x11.c
+++ b/gdk/x11/gdkglconfig-x11.c
@@ -439,7 +439,7 @@ gdk_gl_config_new_common (GdkScreen *screen,
 
 /**
  * gdk_gl_config_new:
- * @attrib_list: a list of attribute/value pairs. The last attribute must
+ * @attrib_list: (array): a list of attribute/value pairs. The last attribute must
  *               be GDK_GL_ATTRIB_LIST_NONE.
  *
  * Returns an OpenGL frame buffer configuration that match the specified
@@ -472,7 +472,7 @@ gdk_gl_config_new (const int *attrib_list)
 /**
  * gdk_gl_config_new_for_screen:
  * @screen: target screen.
- * @attrib_list: a list of attribute/value pairs. The last attribute must
+ * @attrib_list: (array): a list of attribute/value pairs. The last attribute must
  *               be GDK_GL_ATTRIB_LIST_NONE.
  *
  * Returns an OpenGL frame buffer configuration that match the specified
@@ -652,7 +652,7 @@ gdk_x11_gl_config_new_from_visualid_for_screen (GdkScreen *screen,
  *
  * Gets #GdkScreen.
  *
- * Return value: the #GdkScreen.
+ * Return value: (transfer none): the #GdkScreen.
  **/
 GdkScreen *
 gdk_gl_config_get_screen (GdkGLConfig *glconfig)
@@ -666,7 +666,7 @@ gdk_gl_config_get_screen (GdkGLConfig *glconfig)
  * gdk_gl_config_get_attrib:
  * @glconfig: a #GdkGLConfig.
  * @attribute: the attribute to be returned.
- * @value: returns the requested value.
+ * @value: (out): returns the requested value.
  *
  * Gets information about a OpenGL frame buffer configuration.
  *
@@ -696,7 +696,7 @@ gdk_gl_config_get_attrib (GdkGLConfig *glconfig,
  * Gets the #GdkColormap that is appropriate for the OpenGL frame buffer
  * configuration.
  *
- * Return value: the appropriate #GdkColormap.
+ * Return value: (transfer none): the appropriate #GdkColormap.
  **/
 GdkColormap *
 gdk_gl_config_get_colormap (GdkGLConfig *glconfig)
@@ -713,7 +713,7 @@ gdk_gl_config_get_colormap (GdkGLConfig *glconfig)
  * Gets the #GdkVisual that is appropriate for the OpenGL frame buffer
  * configuration.
  *
- * Return value: the appropriate #GdkVisual.
+ * Return value: (transfer none): the appropriate #GdkVisual.
  **/
 GdkVisual *
 gdk_gl_config_get_visual (GdkGLConfig *glconfig)
@@ -745,7 +745,7 @@ gdk_gl_config_get_depth (GdkGLConfig *glconfig)
  *
  * Gets X Display.
  *
- * Return value: pointer to the Display.
+ * Return value: (transfer none): pointer to the Display.
  **/
 Display *
 gdk_x11_gl_config_get_xdisplay (GdkGLConfig *glconfig)
@@ -777,7 +777,7 @@ gdk_x11_gl_config_get_screen_number (GdkGLConfig *glconfig)
  *
  * Gets XVisualInfo data.
  *
- * Return value: pointer to the XVisualInfo data.
+ * Return value: (transfer none): pointer to the XVisualInfo data.
  **/
 XVisualInfo *
 gdk_x11_gl_config_get_xvinfo (GdkGLConfig *glconfig)
diff --git a/gdk/x11/gdkglcontext-x11.c b/gdk/x11/gdkglcontext-x11.c
index 788ad5a..7249eb6 100644
--- a/gdk/x11/gdkglcontext-x11.c
+++ b/gdk/x11/gdkglcontext-x11.c
@@ -247,7 +247,7 @@ _gdk_x11_gl_context_new (GdkGLDrawable *gldrawable,
 /**
  * gdk_x11_gl_context_foreign_new:
  * @glconfig: #GdkGLConfig that represents the visual the GLXContext uses.
- * @share_list: the #GdkGLContext which shares display lists with the
+ * @share_list: (allow-none): the #GdkGLContext which shares display lists with the
  *              GLXContext, or NULL.
  * @glxcontext: exsisting GLXContext.
  *
@@ -385,7 +385,7 @@ _gdk_gl_context_set_gl_drawable_read (GdkGLContext  *glcontext,
  *
  * Gets #GdkGLDrawable to which the @glcontext is bound.
  *
- * Return value: the #GdkGLDrawable or NULL if no #GdkGLDrawable is bound.
+ * Return value: (transfer none): the #GdkGLDrawable or NULL if no #GdkGLDrawable is bound.
  **/
 GdkGLDrawable *
 gdk_gl_context_get_gl_drawable (GdkGLContext *glcontext)
@@ -401,7 +401,7 @@ gdk_gl_context_get_gl_drawable (GdkGLContext *glcontext)
  *
  * Gets #GdkGLConfig with which the @glcontext is configured.
  *
- * Return value: the #GdkGLConfig.
+ * Return value: (transfer none): the #GdkGLConfig.
  **/
 GdkGLConfig *
 gdk_gl_context_get_gl_config (GdkGLContext *glcontext)
@@ -418,7 +418,7 @@ gdk_gl_context_get_gl_config (GdkGLContext *glcontext)
  * Gets #GdkGLContext with which the @glcontext shares the display lists and
  * texture objects.
  *
- * Return value: the #GdkGLContext.
+ * Return value: (transfer none): the #GdkGLContext.
  **/
 GdkGLContext *
 gdk_gl_context_get_share_list (GdkGLContext *glcontext)
@@ -465,7 +465,7 @@ gdk_gl_context_get_render_type (GdkGLContext *glcontext)
  *
  * Returns the current #GdkGLContext.
  *
- * Return value: the current #GdkGLContext or NULL if there is no current
+ * Return value: (transfer none): the current #GdkGLContext or NULL if there is no current
  *               context.
  **/
 GdkGLContext *
diff --git a/gdk/x11/gdkglpixmap-x11.c b/gdk/x11/gdkglpixmap-x11.c
index 0f5af48..8ec389e 100644
--- a/gdk/x11/gdkglpixmap-x11.c
+++ b/gdk/x11/gdkglpixmap-x11.c
@@ -130,7 +130,7 @@ gdk_gl_pixmap_impl_x11_gl_drawable_interface_init (GdkGLDrawableClass *iface)
  * gdk_gl_pixmap_new:
  * @glconfig: a #GdkGLConfig.
  * @pixmap: the #GdkPixmap to be used as the rendering area.
- * @attrib_list: this must be set to NULL or empty (first attribute of None).
+ * @attrib_list: (array) (allow-none): this must be set to NULL or empty (first attribute of None).
  *
  * Creates an off-screen rendering area.
  * attrib_list is currently unused. This must be set to NULL or empty
diff --git a/gdk/x11/gdkglquery-x11.c b/gdk/x11/gdkglquery-x11.c
index 5e9f8ce..ff99e14 100644
--- a/gdk/x11/gdkglquery-x11.c
+++ b/gdk/x11/gdkglquery-x11.c
@@ -70,8 +70,8 @@ gdk_gl_query_extension_for_display (GdkDisplay *display)
 
 /**
  * gdk_gl_query_version:
- * @major: returns the major version number of the OpenGL extension.
- * @minor: returns the minor version number of the OpenGL extension.
+ * @major: (out): returns the major version number of the OpenGL extension.
+ * @minor: (out): returns the minor version number of the OpenGL extension.
  *
  * Returns the version numbers of the OpenGL extension to the window system.
  *
@@ -92,8 +92,8 @@ gdk_gl_query_version (int *major,
 /**
  * gdk_gl_query_version_for_display:
  * @display: the #GdkDisplay where the query is sent to.
- * @major: returns the major version number of the OpenGL extension.
- * @minor: returns the minor version number of the OpenGL extension.
+ * @major: (out): returns the major version number of the OpenGL extension.
+ * @minor: (out): returns the minor version number of the OpenGL extension.
  *
  * Returns the version numbers of the OpenGL extension to the window system.
  *
@@ -194,7 +194,7 @@ gdk_x11_gl_query_glx_extension (GdkGLConfig *glconfig,
  *
  * Returns the address of the OpenGL, GLU, or GLX function.
  *
- * Return value: the address of the function named by @proc_name.
+ * Return value: (type gpointer) (transfer none): the address of the function named by @proc_name.
  **/
 
 #ifdef __APPLE__
diff --git a/gdk/x11/gdkglwindow-x11.c b/gdk/x11/gdkglwindow-x11.c
index fbf0362..3de4539 100644
--- a/gdk/x11/gdkglwindow-x11.c
+++ b/gdk/x11/gdkglwindow-x11.c
@@ -142,7 +142,7 @@ gdk_gl_window_impl_x11_gl_drawable_interface_init (GdkGLDrawableClass *iface)
  * gdk_gl_window_new:
  * @glconfig: a #GdkGLConfig.
  * @window: the #GdkWindow to be used as the rendering area.
- * @attrib_list: this must be set to NULL or empty (first attribute of None).
+ * @attrib_list: (array) (allow-none): this must be set to NULL or empty (first attribute of None).
  *
  * Creates an on-screen rendering area.
  * attrib_list is currently unused. This must be set to NULL or empty
diff --git a/gtk/gtkglinit.c b/gtk/gtkglinit.c
index 611eed3..8b8ec98 100644
--- a/gtk/gtkglinit.c
+++ b/gtk/gtkglinit.c
@@ -42,8 +42,8 @@ static const guint gtk_gl_ndebug_keys = G_N_ELEMENTS (gtk_gl_debug_keys);
 
 /**
  * gtk_gl_parse_args:
- * @argc: the number of command line arguments.
- * @argv: the array of command line arguments.
+ * @argc: (inout): the number of command line arguments.
+ * @argv: (array length=argc) (inout) (allow-none): the array of command line arguments.
  *
  * Parses command line arguments, and initializes global
  * attributes of GtkGLExt.
@@ -168,10 +168,10 @@ gtk_gl_parse_args (int    *argc,
 
 /**
  * gtk_gl_init_check:
- * @argc: Address of the <parameter>argc</parameter> parameter of your
+ * @argc: (inout): Address of the <parameter>argc</parameter> parameter of your
  *        <function>main()</function> function. Changed if any arguments
  *        were handled.
- * @argv: Address of the <parameter>argv</parameter> parameter of
+ * @argv: (array length=argc) (inout) (allow-none): Address of the <parameter>argv</parameter> parameter of
  *        <function>main()</function>. Any parameters understood by
  *        gtk_gl_init() are stripped before return.
  *
@@ -201,10 +201,10 @@ gtk_gl_init_check (int    *argc,
 
 /**
  * gtk_gl_init:
- * @argc: Address of the <parameter>argc</parameter> parameter of your
+ * @argc: (inout): Address of the <parameter>argc</parameter> parameter of your
  *        <function>main()</function> function. Changed if any arguments
  *        were handled.
- * @argv: Address of the <parameter>argv</parameter> parameter of
+ * @argv: (array length=argc) (inout) (allow-none): Address of the <parameter>argv</parameter> parameter of
  *        <function>main()</function>. Any parameters understood by
  *        gtk_gl_init() are stripped before return.
  *
diff --git a/gtk/gtkglwidget.c b/gtk/gtkglwidget.c
index 7381739..e1efa17 100644
--- a/gtk/gtkglwidget.c
+++ b/gtk/gtkglwidget.c
@@ -233,7 +233,7 @@ gl_widget_private_destroy (GLWidgetPrivate *private)
  * gtk_widget_set_gl_capability:
  * @widget: the #GtkWidget to be used as the rendering area.
  * @glconfig: a #GdkGLConfig.
- * @share_list: the #GdkGLContext with which to share display lists and texture
+ * @share_list: (allow-none): the #GdkGLContext with which to share display lists and texture
  *              objects. NULL indicates that no sharing is to take place.
  * @direct: whether rendering is to be done with a direct connection to
  *          the graphics system.
@@ -396,7 +396,7 @@ gtk_widget_is_gl_capable (GtkWidget *widget)
  *
  * Returns the #GdkGLConfig referred by the @widget.
  *
- * Return value: the #GdkGLConfig.
+ * Return value: (transfer none): the #GdkGLConfig.
  **/
 GdkGLConfig *
 gtk_widget_get_gl_config (GtkWidget *widget)
@@ -415,7 +415,7 @@ gtk_widget_get_gl_config (GtkWidget *widget)
 /**
  * gtk_widget_create_gl_context:
  * @widget: a #GtkWidget.
- * @share_list: the #GdkGLContext with which to share display lists and texture
+ * @share_list: (allow-none): the #GdkGLContext with which to share display lists and texture
  *              objects. NULL indicates that no sharing is to take place.
  * @direct: whether rendering is to be done with a direct connection to
  *          the graphics system.
@@ -426,7 +426,7 @@ gtk_widget_get_gl_config (GtkWidget *widget)
  * for this widget. The GL context must be freed when you're
  * finished with it. See also gtk_widget_get_gl_context().
  *
- * Return value: the new #GdkGLContext.
+ * Return value: (transfer full): the new #GdkGLContext.
  **/
 GdkGLContext *
 gtk_widget_create_gl_context (GtkWidget    *widget,
@@ -474,7 +474,7 @@ gtk_widget_create_gl_context (GtkWidget    *widget,
  * #GdkGLContext is needed for the function gdk_gl_drawable_begin,
  * or for sharing display lists (see gtk_widget_set_gl_capability()).
  *
- * Return value: the #GdkGLContext.
+ * Return value: (transfer none): the #GdkGLContext.
  **/
 GdkGLContext *
 gtk_widget_get_gl_context (GtkWidget *widget)
@@ -503,7 +503,7 @@ gtk_widget_get_gl_context (GtkWidget *widget)
  *
  * Returns the #GdkGLWindow owned by the @widget.
  *
- * Return value: the #GdkGLWindow.
+ * Return value: (transfer none): the #GdkGLWindow.
  **/
 GdkGLWindow *
 gtk_widget_get_gl_window (GtkWidget *widget)
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]