]> Pileus Git - ~andy/gtk/commitdiff
[introspection] add transfer none annotation to gdk_keyval_name return
authorJohn (J5) Palmieri <johnp@redhat.com>
Fri, 29 Oct 2010 19:53:37 +0000 (15:53 -0400)
committerJohn (J5) Palmieri <johnp@redhat.com>
Wed, 10 Nov 2010 02:00:14 +0000 (21:00 -0500)
* moved docs from .sgml file to th e.c file so we can add the annotation

docs/reference/gdk/tmpl/keys.sgml
gdk/x11/gdkkeys-x11.c

index ca6c4dcfdddc8fdfc9b52c19c9553b5bb3000378..955086dc3850b1c70f0e3fe4f4c75b8d7cc05f40 100644 (file)
@@ -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.
index 7111c9bf5e8b7ad584f8b2f40fd4420aafbbf660..cb09d1f32891457f9497844dfe8531675a2f81d0 100644 (file)
@@ -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)
 {