From ec9456c9401bad735ef0cc01d805118eee45b34c Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Wed, 26 Aug 2015 13:30:47 +1000 Subject: [PATCH] Make a note that button_get_type is the physical type Signed-off-by: Peter Hutterer --- src/libratbag.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/libratbag.h b/src/libratbag.h index f8876ff1..dff2a34e 100644 --- a/src/libratbag.h +++ b/src/libratbag.h @@ -480,11 +480,11 @@ enum ratbag_button_type { * * Return the type of the physical button. This function is intended to be * used by configuration tools to provide a generic list of button names or - * handles to configure devices. + * handles to configure devices. The type describes the physical location of + * the button and remains constant for the lifetime of the device. * - * FIXME: if we do this with linux/input.h instead, we need to add things like - * BTN_RESOLUTION_UP/DOWN there. But this is supposed to describe the - * physical location of the button, so input.h is not a good match. + * For the button currently mapped to this physical button, see + * ratbag_button_get_button() * * @return The type of the button */