From bb713a7d1eb1ccd72defcddffe32ba9f446a76c3 Mon Sep 17 00:00:00 2001 From: Benign X <1341398182@qq.com> Date: Fri, 27 Oct 2023 16:00:32 +0800 Subject: [PATCH] chore: fix some comment issue (#4715) --- src/core/lv_refr.h | 2 +- src/draw/lv_draw_image.h | 10 +++++++--- src/draw/lv_draw_label.h | 12 +++++++++--- src/draw/lv_draw_line.h | 4 +--- src/draw/lv_draw_rect.h | 2 +- src/draw/lv_image_buf.h | 3 ++- src/draw/sw/lv_draw_sw_triangle.c | 6 ++---- 7 files changed, 23 insertions(+), 16 deletions(-) diff --git a/src/core/lv_refr.h b/src/core/lv_refr.h index 32921db9f..5bc6c667f 100644 --- a/src/core/lv_refr.h +++ b/src/core/lv_refr.h @@ -57,7 +57,7 @@ void lv_refr_now(lv_display_t * disp); /** * Redrawn on object an all its children using the passed draw context - * @param draw_ctx pointer to an initialized draw context + * @param layer pointer to a layer where to draw. * @param obj the start object from the redraw should start */ void lv_obj_redraw(lv_layer_t * layer, lv_obj_t * obj); diff --git a/src/draw/lv_draw_image.h b/src/draw/lv_draw_image.h index 22869d532..552693b36 100644 --- a/src/draw/lv_draw_image.h +++ b/src/draw/lv_draw_image.h @@ -69,14 +69,18 @@ void lv_draw_image_dsc_init(lv_draw_image_dsc_t * dsc); /** * Draw an image - * @param draw_ctx pointer to the current draw context + * @param layer pointer to a layer * @param dsc pointer to an initialized `lv_draw_image_dsc_t` variable * @param coords the coordinates of the image - * @param src pointer to a lv_color_t array which contains the pixels of the image */ void lv_draw_image(struct _lv_layer_t * layer, const lv_draw_image_dsc_t * dsc, const lv_area_t * coords); - +/** + * Draw a layer on an other layer + * @param layer pointer to a layer + * @param dsc pointer to an initialized `lv_draw_image_dsc_t` variable + * @param coords the coordinates of the layer + */ void lv_draw_layer(struct _lv_layer_t * layer, const lv_draw_image_dsc_t * dsc, const lv_area_t * coords); /** diff --git a/src/draw/lv_draw_label.h b/src/draw/lv_draw_label.h index 41c6fd9f0..08f71fb80 100644 --- a/src/draw/lv_draw_label.h +++ b/src/draw/lv_draw_label.h @@ -107,16 +107,22 @@ void lv_draw_letter_dsc_init(lv_draw_glyph_dsc_t * dsc); /** * Write a text - * @param draw_ctx pointer to the current draw context + * @param layer pointer to a layer * @param dsc pointer to draw descriptor * @param coords coordinates of the label - * @param txt `\0` terminated text to write - * @param hint pointer to a `lv_draw_label_hint_t` variable. * It is managed by the draw to speed up the drawing of very long texts (thousands of lines). */ LV_ATTRIBUTE_FAST_MEM void lv_draw_label(lv_layer_t * layer, const lv_draw_label_dsc_t * dsc, const lv_area_t * coords); +/** + * Write a text + * @param layer pointer to a layer + * @param dsc pointer to draw descriptor + * @param point position of the label + * @param unicode_letter the letter to draw + * It is managed by the draw to speed up the drawing of very long texts (thousands of lines). + */ LV_ATTRIBUTE_FAST_MEM void lv_draw_letter(lv_layer_t * layer, lv_draw_label_dsc_t * dsc, const lv_point_t * point, uint32_t unicode_letter); diff --git a/src/draw/lv_draw_line.h b/src/draw/lv_draw_line.h index 467a710e1..2f5236d02 100644 --- a/src/draw/lv_draw_line.h +++ b/src/draw/lv_draw_line.h @@ -51,10 +51,8 @@ LV_ATTRIBUTE_FAST_MEM void lv_draw_line_dsc_init(lv_draw_line_dsc_t * dsc); /** * Draw a line - * @param draw_ctx pointer to the current draw context + * @param layer pointer to a layer * @param dsc pointer to an initialized `lv_draw_line_dsc_t` variable - * @param point1 first point of the line - * @param point2 second point of the line */ void lv_draw_line(struct _lv_layer_t * layer, const lv_draw_line_dsc_t * dsc); diff --git a/src/draw/lv_draw_rect.h b/src/draw/lv_draw_rect.h index 8e82c335f..97e02d204 100644 --- a/src/draw/lv_draw_rect.h +++ b/src/draw/lv_draw_rect.h @@ -136,7 +136,7 @@ void lv_draw_bg_image_dsc_init(lv_draw_bg_image_dsc_t * dsc); /** * Draw a rectangle - * @param draw_ctx pointer to the current draw context + * @param layer pointer to a layer * @param dsc pointer to an initialized `lv_draw_rect_dsc_t` variable * @param coords the coordinates of the rectangle */ diff --git a/src/draw/lv_image_buf.h b/src/draw/lv_image_buf.h index b0ab1b813..3032d2d24 100644 --- a/src/draw/lv_image_buf.h +++ b/src/draw/lv_image_buf.h @@ -112,7 +112,8 @@ void lv_image_buf_free(lv_image_dsc_t * dsc); * @param w width of the rectangle to transform * @param h height of the rectangle to transform * @param angle angle of rotation - * @param zoom zoom, (256 no zoom) + * @param zoom_x zoom in x direction, (256 no zoom) + * @param zoom_y zoom in y direction, (256 no zoom) * @param pivot x,y pivot coordinates of rotation */ void _lv_image_buf_get_transformed_area(lv_area_t * res, lv_coord_t w, lv_coord_t h, lv_coord_t angle, uint16_t zoom_x, diff --git a/src/draw/sw/lv_draw_sw_triangle.c b/src/draw/sw/lv_draw_sw_triangle.c index 073d1e330..2550f76f2 100644 --- a/src/draw/sw/lv_draw_sw_triangle.c +++ b/src/draw/sw/lv_draw_sw_triangle.c @@ -179,10 +179,8 @@ void lv_draw_sw_triangle(lv_draw_unit_t * draw_unit, const lv_draw_triangle_dsc_ } #else - LV_UNUSED(points); - LV_UNUSED(point_cnt); - LV_UNUSED(draw_ctx); - LV_UNUSED(draw_dsc); + LV_UNUSED(draw_unit); + LV_UNUSED(dsc); LV_LOG_WARN("Can't draw triangles with LV_DRAW_SW_COMPLEX == 0"); #endif /*LV_DRAW_SW_COMPLEX*/ }