diff --git a/pkg/lvgl/include/lvgl_riot.h b/pkg/lvgl/include/lvgl_riot.h index 21203d9a3e..595e3d3982 100644 --- a/pkg/lvgl/include/lvgl_riot.h +++ b/pkg/lvgl/include/lvgl_riot.h @@ -33,8 +33,14 @@ extern "C" { void lvgl_init(screen_dev_t *screen_dev); /** - * Run the lvgl task handler -*/ + * @brief Run the lvgl task handler + * + * In order to run the lvgl internal task handler in an endless loop, this + * function must be called manually either from the main thread or from a + * custom thread. + * In case of CONFIG_LVGL_INACTIVITY_PERIOD_MS ms of inactivity, the loop stops + * the thread running the lvgl task handler until @ref lvgl_wakeup is called. + */ void lvgl_run(void); /**