diff --git a/src/W800 SDK v1.00.08/app/app_drivers/lcd/lcd.h b/src/W800 SDK v1.00.08/app/app_drivers/lcd/lcd.h index 7dd4f24..f319fff 100644 --- a/src/W800 SDK v1.00.08/app/app_drivers/lcd/lcd.h +++ b/src/W800 SDK v1.00.08/app/app_drivers/lcd/lcd.h @@ -6,7 +6,7 @@ /* Used SOC : W800 or W801 */ #define W800 -/* Display drive controller */ +/* Display controller IC */ #define ILI9341 0 #define ST7789V 1 #define GC9A01 2 @@ -69,7 +69,7 @@ typedef struct LCDConfig * @brief Initializes the LCDConfig object to known values * Must be called before using any other LCD Driver API functions * - * @param LCDConfig a pointer a user allocated LCDConfig_t structure + * @param LCDConfig a pointer to a user allocated LCDConfig_t structure */ void lcd_config_init(LCDConfig_t * const LCDConfig); @@ -78,7 +78,7 @@ void lcd_config_init(LCDConfig_t * const LCDConfig); * Usually called once the DMA engine is done with the transfer. * /!\ MUST BE CALLED BEFORE lcd_init FUNCTION * - * @param LCDConfig a pointer a user allocated LCDConfig_t structure + * @param LCDConfig a pointer to a user allocated LCDConfig_t structure * @param drawFinishedCb the function to register of the form : void myFunc(void *arg) * @param arg a pointer to an optional argument passed to the callback function */ @@ -87,14 +87,14 @@ void lcd_register_draw_finished_cb(LCDConfig_t * const LCDConfig, DrawFinishedCb /** * @brief Initializes IOs using the configured LCDConfig object and the LCD display * - * @param LCDConfig a pointer a user allocated LCDConfig_t structure + * @param LCDConfig a pointer to a user allocated LCDConfig_t structure */ void lcd_init(LCDConfig_t * const LCDConfig); /** * @brief Writes the frame to display's internal RAM * - * @param LCDConfig a pointer a user allocated LCDConfig_t structure + * @param LCDConfig a pointer to a user allocated LCDConfig_t structure * @param x * @param y * @param width @@ -104,9 +104,9 @@ void lcd_init(LCDConfig_t * const LCDConfig); void lcd_draw_rect_frame(LCDConfig_t * const LCDConfig, uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint8_t *data); /** - * @brief Sets the backlight to the specified brightness value + * @brief Sets the backlight to the specified brightness value (0 to 255) * - * @param LCDConfig a pointer a user allocated LCDConfig_t structure + * @param LCDConfig a pointer to a user allocated LCDConfig_t structure * @param brightness a value from 0 (backlight off) to 255 backlight fully on. */ void lcd_set_backlight(LCDConfig_t * const LCDConfig, uint8_t brightness); @@ -114,14 +114,14 @@ void lcd_set_backlight(LCDConfig_t * const LCDConfig, uint8_t brightness); /** * @brief Issues a hardware reset of the lcd display * - * @param LCDConfig a pointer a user allocated LCDConfig_t structure + * @param LCDConfig a pointer to a user allocated LCDConfig_t structure */ void lcd_hardware_reset(LCDConfig_t * const LCDConfig); /** * @brief Turns the LCD on or off, /!\ not the same as sleep mode ! * - * @param LCDConfig a pointer a user allocated LCDConfig_t structure + * @param LCDConfig a pointer to a user allocated LCDConfig_t structure * @param state true to turn the LCD on or false to turn it off */ void lcd_on(LCDConfig_t * const LCDConfig, bool state); @@ -130,7 +130,7 @@ void lcd_on(LCDConfig_t * const LCDConfig, bool state); * @brief Puts the LCD in power down mode (sleep) or power up mode (active) * Sleep mode puts the LCD in it's lowest power state * - * @param LCDConfig a pointer a user allocated LCDConfig_t structure + * @param LCDConfig a pointer to a user allocated LCDConfig_t structure * @param state true to put the LCD in sleep mode or false to put it in active mode */ void lcd_sleep(LCDConfig_t * const LCDConfig, bool state); @@ -138,7 +138,7 @@ void lcd_sleep(LCDConfig_t * const LCDConfig, bool state); /** * @brief Sets the LCD orientation. * - * @param LCDConfig a pointer a user allocated LCDConfig_t structure + * @param LCDConfig a pointer to a user allocated LCDConfig_t structure * @param orientation the value of the orientation to set */ void lcd_orientation(LCDConfig_t * const LCDConfig, LCDOrientation_t orientation);