From b96ddf1635b94351ddc833371c7481a975c039eb Mon Sep 17 00:00:00 2001 From: Bartosz Golaszewski Date: Wed, 11 Oct 2017 17:01:04 +0200 Subject: [PATCH] simple-api: improve documentation Mention the meaning of a positive value returned from the polling callback of the simple event loop routines. Signed-off-by: Bartosz Golaszewski --- include/gpiod.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/include/gpiod.h b/include/gpiod.h index 7ef3ce4..264c403 100644 --- a/include/gpiod.h +++ b/include/gpiod.h @@ -168,6 +168,9 @@ typedef int (*gpiod_simple_event_handle_cb)(int, unsigned int, /** * @brief Return status values that the simple event poll callback can return. + * + * Positive value returned from the polling callback indicates the number of + * events that occurred on the set of monitored lines. */ enum { GPIOD_SIMPLE_EVENT_POLL_RET_STOP = -2, -- 2.30.2