summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorDaniel Stone <daniel@fooishbar.org>2012-05-09 20:52:33 +0100
committerDaniel Stone <daniel@fooishbar.org>2012-05-09 20:52:33 +0100
commit471e112208e9d828f90c37cfa9608fd1aa20fcb3 (patch)
tree3a5a06555ea8a40c6e2c405640d98886f2907b46 /include
parent7a1201bdf2386dde5c5c919f2dab55b91c9cabc0 (diff)
downloadxorg-lib-libxkbcommon-471e112208e9d828f90c37cfa9608fd1aa20fcb3.tar.gz
Document that xkb_state_get_map doesn't take a ref
Signed-off-by: Daniel Stone <daniel@fooishbar.org>
Diffstat (limited to 'include')
-rw-r--r--include/xkbcommon/xkbcommon.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/xkbcommon/xkbcommon.h b/include/xkbcommon/xkbcommon.h
index 541b571..ce226f7 100644
--- a/include/xkbcommon/xkbcommon.h
+++ b/include/xkbcommon/xkbcommon.h
@@ -390,7 +390,9 @@ void
xkb_state_unref(struct xkb_state *state);
/**
- * Get the keymap from which the state object was created.
+ * Get the keymap from which the state object was created. Does not take
+ * a new reference on the map; you must explicitly reference it yourself
+ * if you plan to use it beyond the lifetime of the state.
*/
struct xkb_keymap *
xkb_state_get_map(struct xkb_state *state);