From 5a393c64d6587cb7acfdefe25076561f6f7626c4 Mon Sep 17 00:00:00 2001
From: Alexandre Abadie <alexandre.abadie@inria.fr>
Date: Fri, 21 May 2021 10:05:17 +0200
Subject: [PATCH] pkg/lvgl: improve lvgl_run documentation

---
 pkg/lvgl/include/lvgl_riot.h | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

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);
 
 /**