[gtk+] [introspection] add transfer none annotation to gdk_keyval_name return



commit cdf517d1c8e74bca417f8abe4d74ce0104772bf7
Author: John (J5) Palmieri <johnp redhat com>
Date:   Fri Oct 29 15:53:37 2010 -0400

    [introspection] add transfer none annotation to gdk_keyval_name return
    
    * moved docs from .sgml file to th e.c file so we can add the annotation

 docs/reference/gdk/tmpl/keys.sgml |   12 ------------
 gdk/x11/gdkkeys-x11.c             |   14 +++++++++++++-
 2 files changed, 13 insertions(+), 13 deletions(-)
---
diff --git a/docs/reference/gdk/tmpl/keys.sgml b/docs/reference/gdk/tmpl/keys.sgml
index ca6c4dc..955086d 100644
--- a/docs/reference/gdk/tmpl/keys.sgml
+++ b/docs/reference/gdk/tmpl/keys.sgml
@@ -265,18 +265,6 @@ Returns: %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL.
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_keyval_name ##### -->
-<para>
-Converts a key value into a symbolic name.
-The names are the same as those in the <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> header file
-but without the leading "GDK_KEY_".
-</para>
-
- keyval: a key value.
- Returns: a string containing the name of the key, or %NULL if @keyval is not
-a valid key. The string should not be modified.
-
-
 <!-- ##### FUNCTION gdk_keyval_from_name ##### -->
 <para>
 Converts a key name to a key value.
diff --git a/gdk/x11/gdkkeys-x11.c b/gdk/x11/gdkkeys-x11.c
index 7111c9b..cb09d1f 100644
--- a/gdk/x11/gdkkeys-x11.c
+++ b/gdk/x11/gdkkeys-x11.c
@@ -1606,7 +1606,19 @@ gdk_keymap_translate_keyboard_state (GdkKeymap       *keymap,
 
 
 /* Key handling not part of the keymap */
-
+/**
+ * gdk_keyval_name:
+ *
+ * Converts a key value into a symbolic name.
+ * 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.
+ **/
 gchar*
 gdk_keyval_name (guint	      keyval)
 {



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