From c46f6b0a41da4593f87d1d6d0337a94451c4cb38 Mon Sep 17 00:00:00 2001 From: Victor Wheeler Date: Mon, 26 Aug 2024 05:38:37 -0600 Subject: [PATCH] Fix/Doxygen warning stragglers caused by recent merges (#6736) --- src/draw/lv_draw_buf.h | 12 ++++++------ src/draw/sw/lv_draw_sw_gradient.h | 4 ++-- src/indev/lv_indev.h | 6 +++--- src/misc/lv_anim.h | 4 ++-- src/misc/lv_fs.h | 2 +- src/widgets/list/lv_list.h | 1 - src/widgets/tabview/lv_tabview.h | 1 + 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/draw/lv_draw_buf.h b/src/draw/lv_draw_buf.h index 8d34476239..9cc6526e5a 100644 --- a/src/draw/lv_draw_buf.h +++ b/src/draw/lv_draw_buf.h @@ -87,10 +87,10 @@ typedef uint32_t (*lv_draw_buf_width_to_stride_cb)(uint32_t w, lv_color_format_t struct lv_draw_buf_t { lv_image_header_t header; - uint32_t data_size; /*Total buf size in bytes*/ + uint32_t data_size; /**< Total buf size in bytes */ uint8_t * data; - void * unaligned_data; /*Unaligned address of `data`, used internally by lvgl*/ - const lv_draw_buf_handlers_t * handlers; /* draw buffer alloc/free ops. */ + void * unaligned_data; /**< Unaligned address of `data`, used internally by lvgl */ + const lv_draw_buf_handlers_t * handlers; /**< draw buffer alloc/free ops. */ }; /********************** @@ -112,7 +112,7 @@ void lv_draw_buf_init_with_default_handlers(lv_draw_buf_handlers_t * handlers); * @param buf_free_cb the callback to free memory of the buffer * @param align_pointer_cb the callback to align the buffer * @param invalidate_cache_cb the callback to invalidate the cache of the buffer - * @param flush_cache_cb ??? + * @param flush_cache_cb the callback to flush buffer * @param width_to_stride_cb the callback to calculate the stride based on the width and color format */ void lv_draw_buf_handlers_init(lv_draw_buf_handlers_t * handlers, @@ -275,10 +275,10 @@ lv_draw_buf_t * lv_draw_buf_reshape(lv_draw_buf_t * draw_buf, lv_color_format_t uint32_t stride); /** - * Destroy a draw buf by free the actual buffer if it's marked as LV_IMAGE_FLAGS_ALLOCATED in header. + * Destroy a draw buf by freeing the actual buffer if it's marked as LV_IMAGE_FLAGS_ALLOCATED in header. * Then free the lv_draw_buf_t struct. * - * @param buf the draw buffer to destroy + * @param draw_buf the draw buffer to destroy */ void lv_draw_buf_destroy(lv_draw_buf_t * draw_buf); diff --git a/src/draw/sw/lv_draw_sw_gradient.h b/src/draw/sw/lv_draw_sw_gradient.h index 647affc976..01029cbab4 100644 --- a/src/draw/sw/lv_draw_sw_gradient.h +++ b/src/draw/sw/lv_draw_sw_gradient.h @@ -44,8 +44,8 @@ typedef lv_color_t lv_grad_color_t; * @param dsc The gradient descriptor to use * @param range The range to use in computation. * @param frac The current part used in the range. frac is in [0; range] - * @param color_out ??? - * @param opa_out ??? + * @param color_out Calculated gradient color + * @param opa_out Calculated opacity */ void /* LV_ATTRIBUTE_FAST_MEM */ lv_gradient_color_calculate(const lv_grad_dsc_t * dsc, int32_t range, diff --git a/src/indev/lv_indev.h b/src/indev/lv_indev.h index f67a4ea52d..9b0ee4518c 100644 --- a/src/indev/lv_indev.h +++ b/src/indev/lv_indev.h @@ -146,9 +146,9 @@ void lv_indev_set_driver_data(lv_indev_t * indev, void * driver_data); void lv_indev_set_display(lv_indev_t * indev, struct lv_display_t * disp); /** - * Set long press time to the indev - * @param indev pointer to an input device - * @param time long press time in ms + * Set long press time to indev + * @param indev pointer to input device + * @param long_press_time time long press time in ms */ void lv_indev_set_long_press_time(lv_indev_t * indev, uint16_t long_press_time); diff --git a/src/misc/lv_anim.h b/src/misc/lv_anim.h index 06fb88762e..0d626c89bc 100644 --- a/src/misc/lv_anim.h +++ b/src/misc/lv_anim.h @@ -112,7 +112,7 @@ typedef int32_t (*lv_anim_get_value_cb_t)(lv_anim_t *); /** Callback used when the animation is deleted*/ typedef void (*lv_anim_deleted_cb_t)(lv_anim_t *); -/**< Parameter used when path is custom_bezier */ +/** Parameter used when path is custom_bezier */ typedef struct { int16_t x1; int16_t y1; @@ -122,7 +122,7 @@ typedef struct { /** Describes an animation*/ struct lv_anim_t { - void * var; /**