From d695cf1ab7f13cd00e8a99e13c7d33ad0cdeb10b Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Fri, 4 Mar 2022 11:52:03 +1000 Subject: [PATCH] doc: fix the documentation for the eis capabilities --- src/libei.h | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/src/libei.h b/src/libei.h index 67dbff8..efcf7c6 100644 --- a/src/libei.h +++ b/src/libei.h @@ -123,15 +123,16 @@ struct ei_region; /** * @enum ei_device_capability * - * The set of supported capabilities. A device may have one or more - * capabilities but never zero - a EIS implementation must reject any - * device with zero capabilities. + * The set of supported capabilities. A device may have zero or more + * capabilities, a device with perceived zero capabilities is typically a + * device with capabilities unsupported by the client. * - * Capabilities are requested by the client but the EIS - * implementation may further reduce the capabilities. For example, a client - * may request the pointer and keyboard capability but only the former is - * permitted by the server. Any keyboard events sent by such a device events - * will be treated as client bug and discarded. + * Capabilities are initialized by the EIS implementation but the client may + * further reduce the requested capabilities, see ei_seat_drop_capability(). + * For example, a client may bind to a seat with the pointer and keyboard + * capability but only the former is permitted by the EIS implementation. + * Keyboard events sent through such a device will be treated as client bug + * and discarded. * * See eis_device_has_capability(). *