summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosé Expósito <jose.exposito89@gmail.com>2023-03-25 19:33:05 +0100
committerJosé Expósito <jose.exposito89@gmail.com>2023-03-25 19:33:05 +0100
commitf8497bf176ef4a7fcdb41ac8268be2e899b05a64 (patch)
treef898d40c978fc96588b310c6fcc59efa7a2d941c
parent0b005eb64b12603e65a620a77c67ec62fd03f413 (diff)
downloadlibinput-f8497bf176ef4a7fcdb41ac8268be2e899b05a64.tar.gz
doc: document libinput_device_tablet_pad_get_* error case
Like in libinput_device_switch_has_switch()'s documentation, document the error case in libinput_device_tablet_pad_get_num_buttons(), libinput_device_tablet_pad_get_num_rings() and libinput_device_tablet_pad_get_num_strips(). Signed-off-by: José Expósito <jose.exposito89@gmail.com>
-rw-r--r--src/libinput.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/libinput.h b/src/libinput.h
index 7c0a9a75..27270495 100644
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -4370,7 +4370,7 @@ libinput_device_switch_has_switch(struct libinput_device *device,
*
* @param device A current input device
*
- * @return The number of buttons supported by the device.
+ * @return The number of buttons supported by the device. -1 on error.
*
* @since 1.3
*/
@@ -4385,7 +4385,7 @@ libinput_device_tablet_pad_get_num_buttons(struct libinput_device *device);
*
* @param device A current input device
*
- * @return The number of rings or 0 if the device has no rings.
+ * @return The number of rings or 0 if the device has no rings. -1 on error.
*
* @see libinput_event_tablet_pad_get_ring_number
*
@@ -4402,7 +4402,7 @@ libinput_device_tablet_pad_get_num_rings(struct libinput_device *device);
*
* @param device A current input device
*
- * @return The number of strips or 0 if the device has no strips.
+ * @return The number of strips or 0 if the device has no strips. -1 on error.
*
* @see libinput_event_tablet_pad_get_strip_number
*