summaryrefslogtreecommitdiff
path: root/libevdev/libevdev.h
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2013-07-01 09:35:16 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2013-07-01 09:35:16 +1000
commit5db85056a2cbb404228e79bd3ab6b5098a565284 (patch)
tree6a4e20f22588daed4551a6cdd4d0cd84fd2c6470 /libevdev/libevdev.h
parent1baeedc9536dda05a71189f1255773e689f17eb7 (diff)
downloadlibevdev-5db85056a2cbb404228e79bd3ab6b5098a565284.tar.gz
Require data be NULL when enabling a non-EV_ABS axis
In the future this may change, but for now enforce that callers use NULL. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'libevdev/libevdev.h')
-rw-r--r--libevdev/libevdev.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/libevdev/libevdev.h b/libevdev/libevdev.h
index ec3c12e..d8f04f4 100644
--- a/libevdev/libevdev.h
+++ b/libevdev/libevdev.h
@@ -757,9 +757,9 @@ int libevdev_disable_event_type(struct libevdev *dev, unsigned int type);
* report such events, it will now return true for libevdev_has_event_code().
*
* The last argument depends on the type and code:
- * - If type is EV_ABS, the vararg must be a pointer to a struct input_absinfo
+ * - If type is EV_ABS, data must be a pointer to a struct input_absinfo
* containing the data for this axis.
- * - For all other types, the argument is ignored.
+ * - For all other types, the argument must be NULL.
*
* This function calls libevdev_enable_event_type() if necessary.
*
@@ -769,7 +769,8 @@ int libevdev_disable_event_type(struct libevdev *dev, unsigned int type);
* @param dev The evdev device, already initialized with libevdev_set_fd()
* @param type The event type to enable (EV_ABS, EV_KEY, ...)
* @param code The event code to enable (ABS_X, REL_X, etc.)
- * @param data Axis/key data, depending on type and code
+ * @param data If type is EV_ABS, data points to a struct input_absinfo. Otherwise, data must be
+ * NULL
*
* @return 0 on success or -1 otherwise
*