Commit d9f934ca42d41e5db83fe2c6d8f839cb8a216c1b
2012-03-23T16:52:23
Mention xkb_state_new can return NULL in the header comments. Signed-off-by: Ran Benita <ran234@gmail.com>
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);