lv_hal: comment update

This commit is contained in:
Gabor Kiss-Vamosi
2017-10-20 22:41:10 +02:00
parent 964499a06f
commit 816327f4f7
7 changed files with 70 additions and 53 deletions

View File

@@ -93,22 +93,14 @@ typedef struct _lv_indev_t {
* GLOBAL PROTOTYPES
**********************/
/**
* Register Input Device driver
*
* @param driver Input Device driver structure
* @return 0 on success, -ve on error
* Register an initialized input device driver.
* @param driver pointer to an initialized 'lv_indev_drv_t' variable (can be local variable)
* @return pointer to the new input device or NULL on error
*/
lv_indev_t * lv_indev_register(lv_indev_drv_t *driver);
/**
* Ask data from an input device.
* @param data input device data
* @return false: no more data; true: there more data to read (buffered)
*/
bool lv_indev_read(lv_indev_t * indev, lv_indev_data_t *data);
/**
* Get the next input device.
* @param indev pointer to the current input device. NULL to initialize.
@@ -116,6 +108,14 @@ bool lv_indev_read(lv_indev_t * indev, lv_indev_data_t *data);
*/
lv_indev_t * lv_indev_next(lv_indev_t * indev);
/**
* Read data from an input device.
* @param indev pointer to an input device
* @param data input device will write its data here
* @return false: no more data; true: there more data to read (buffered)
*/
bool lv_indev_read(lv_indev_t * indev, lv_indev_data_t *data);
/**********************
* MACROS
**********************/