summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorRan Benita <ran234@gmail.com>2012-03-23 16:52:23 +0200
committerDaniel Stone <daniel@fooishbar.org>2012-03-27 13:58:27 +0100
commitd9f934ca42d41e5db83fe2c6d8f839cb8a216c1b (patch)
tree7d87d48dd4a6a4e497ad518126e0ee8fe7eacdf8 /include
parent087327d9c505ff8b9b00d998754528a347152851 (diff)
downloadxorg-lib-libxkbcommon-d9f934ca42d41e5db83fe2c6d8f839cb8a216c1b.tar.gz
Mention xkb_state_new can return NULL
in the header comments. Signed-off-by: Ran Benita <ran234@gmail.com>
Diffstat (limited to 'include')
-rw-r--r--include/xkbcommon/xkbcommon.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/include/xkbcommon/xkbcommon.h b/include/xkbcommon/xkbcommon.h
index cdf0d7c..0679235 100644
--- a/include/xkbcommon/xkbcommon.h
+++ b/include/xkbcommon/xkbcommon.h
@@ -318,7 +318,8 @@ xkb_map_led_get_index(struct xkb_desc *xkb, const char *name);
*/
/**
- * Allocates a new XKB state object for use with the given keymap.
+ * Returns a new XKB state object for use with the given keymap, or NULL on
+ * failure.
*/
_X_EXPORT struct xkb_state *
xkb_state_new(struct xkb_desc *xkb);