[gtk+/gtk-2-24] Document that keymap functions will stop accepting NULL

[Matthias Clasen <matthiasc src gnome org>]

commit e2361108f4e295818578f53f7d7b7231ceeadbb7
Author: Matthias Clasen <mclasen redhat com>
Date:   Thu Dec 23 10:15:59 2010 -0500

    Document that keymap functions will stop accepting NULL

 gdk/x11/gdkkeys-x11.c |   22 ++++++++++++++++++++--
 1 files changed, 20 insertions(+), 2 deletions(-)
---
diff --git a/gdk/x11/gdkkeys-x11.c b/gdk/x11/gdkkeys-x11.c
index 8934b0e..ae4d7fa 100644
--- a/gdk/x11/gdkkeys-x11.c
+++ b/gdk/x11/gdkkeys-x11.c
@@ -736,8 +736,11 @@ _gdk_keymap_keys_changed (GdkDisplay *display)
  *
  * Returns the direction of effective layout of the keymap.
  *
- * Returns: %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL 
- *   if it can determine the direction. %PANGO_DIRECTION_NEUTRAL 
+ * Note that passing %NULL for @keymap is deprecated and will stop
+ * to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
+ *
+ * Returns: %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL
+ *   if it can determine the direction. %PANGO_DIRECTION_NEUTRAL
  *   otherwise.
  **/
 PangoDirection
@@ -774,6 +777,9 @@ gdk_keymap_get_direction (GdkKeymap *keymap)
  * Determines if keyboard layouts for both right-to-left and left-to-right
  * languages are in use.
  *
+ * Note that passing %NULL for @keymap is deprecated and will stop
+ * to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
+ *
  * Returns: %TRUE if there are layouts in both directions, %FALSE otherwise
  *
  * Since: 2.12
@@ -851,6 +857,9 @@ gdk_keymap_get_caps_lock_state (GdkKeymap *keymap)
  * The returned array should be freed
  * with g_free().
  *
+ * Note that passing %NULL for @keymap is deprecated and will stop
+ * to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
+ *
  * Return value: %TRUE if keys were found and returned
  **/
 gboolean
@@ -997,6 +1006,9 @@ gdk_keymap_get_entries_for_keyval (GdkKeymap     *keymap,
  * this list of entries is selected by considering the effective
  * keyboard group and level. See gdk_keymap_translate_keyboard_state().
  *
+ * Note that passing %NULL for @keymap is deprecated and will stop
+ * to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
+ *
  * Returns: %TRUE if there were any entries
  **/
 gboolean
@@ -1153,6 +1165,9 @@ gdk_keymap_get_entries_for_keycode (GdkKeymap     *keymap,
  * this function, since the effective group/level may not be
  * the same as the current keyboard state.
  * 
+ * Note that passing %NULL for @keymap is deprecated and will stop
+ * to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
+ *
  * Return value: a keyval, or 0 if none was mapped to the given @key
  **/
 guint
@@ -1472,6 +1487,9 @@ translate_keysym (GdkKeymapX11   *keymap_x11,
  * not <literal>&lt;Control&gt;&lt;Shift&gt;plus</literal>,
  * </para></note>
  * 
+ * Note that passing %NULL for @keymap is deprecated and will stop
+ * to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
+ *
  * Return value: %TRUE if there was a keyval bound to the keycode/state/group
  **/
 gboolean