From d227a117a209d4024657dd852aadace8e4f5f5f3 Mon Sep 17 00:00:00 2001 From: Alexandre Abadie Date: Wed, 3 Mar 2021 18:04:42 +0100 Subject: [PATCH] drivers/screen_dev: add a bit of documentation --- drivers/include/screen_dev.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/drivers/include/screen_dev.h b/drivers/include/screen_dev.h index 775c6cb7ea..b61937c86f 100644 --- a/drivers/include/screen_dev.h +++ b/drivers/include/screen_dev.h @@ -11,6 +11,17 @@ * @ingroup drivers_display * @brief Define the generic API of a screen device * + * The screen device API is a generic API built on top of display and touch + * device APIs. + * + * Each display/touch device driver implementing this interface has to expose + * a set of predefined functions and it has to register itself to the central + * display/touch device registry. From here devices can be found, listed, and + * accessed. + * + * The display and touch devices are linked to a screen by providing the + * screen id (basically an index) they correspond to. + * * @see drivers_disp_dev @see drivers_touch_dev * * @experimental This API is experimental and in an early state - expect