Add a note that libevdev_is_event_type/code have compile-time ranges
authorPeter Hutterer <peter.hutterer@who-t.net>
Fri, 23 Aug 2013 00:26:36 +0000 (10:26 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Thu, 29 Aug 2013 01:36:20 +0000 (11:36 +1000)
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Acked-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>
libevdev/libevdev.h

index 6113f41..24fa9eb 100644 (file)
@@ -1211,6 +1211,9 @@ int libevdev_kernel_set_led_values(struct libevdev *dev, ...);
  * with the exception that some sanity checks are performed to ensure type
  * is valid.
  *
+ * @note The ranges for types are compiled into libevdev. If the kernel
+ * changes the max value, libevdev will not automatically pick these up.
+ *
  * @param ev The input event to check
  * @param type Input event type to compare the event against (EV_REL, EV_ABS,
  * etc.)
@@ -1231,6 +1234,9 @@ int libevdev_is_event_type(const struct input_event *ev, unsigned int type);
  * with the exception that some sanity checks are performed to ensure type and
  * code are valid.
  *
+ * @note The ranges for types and codes are compiled into libevdev. If the kernel
+ * changes the max value, libevdev will not automatically pick these up.
+ *
  * @param ev The input event to check
  * @param type Input event type to compare the event against (EV_REL, EV_ABS,
  * etc.)