Fix/Doxygen warning stragglers caused by recent merges (#6736)

This commit is contained in:
Victor Wheeler
2024-08-26 05:38:37 -06:00
committed by GitHub
parent f4ea1ec82c
commit c46f6b0a41
7 changed files with 15 additions and 15 deletions
+6 -6
View File
@@ -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);
+2 -2
View File
@@ -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,
+3 -3
View File
@@ -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);
+2 -2
View File
@@ -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; /**<Variable to animate*/
void * var; /**< Variable to animate*/
lv_anim_exec_xcb_t exec_cb; /**< Function to execute to animate*/
lv_anim_custom_exec_cb_t custom_exec_cb; /**< Function to execute to animate,
* same purpose as exec_cb but different parameters*/
+1 -1
View File
@@ -175,7 +175,7 @@ lv_fs_res_t lv_fs_write(lv_fs_file_t * file_p, const void * buf, uint32_t btw, u
* Set the position of the 'cursor' (read write pointer) in a file
* @param file_p pointer to a lv_fs_file_t variable
* @param pos the new position expressed in bytes index (0: start of file)
* @param whence tells from where to set position. See @lv_fs_whence_t
* @param whence tells from where to set position. See lv_fs_whence_t
* @return LV_FS_RES_OK or any error from lv_fs_res_t enum
*/
lv_fs_res_t lv_fs_seek(lv_fs_file_t * file_p, uint32_t pos, lv_fs_whence_t whence);
-1
View File
@@ -69,7 +69,6 @@ const char * lv_list_get_button_text(lv_obj_t * list, lv_obj_t * btn);
* @param list pointer to a list
* @param btn pointer to the button
* @param txt pointer to the text
* @return text of btn, if btn doesn't have text "" will be returned
*/
void lv_list_set_button_text(lv_obj_t * list, lv_obj_t * btn, const char * txt);
+1
View File
@@ -68,6 +68,7 @@ void lv_tabview_set_tab_bar_position(lv_obj_t * obj, lv_dir_t dir);
/**
* Set the width or height of the tab bar
* @param obj pointer to tabview widget
* @param size size of the tab bar in pixels or percentage.
* will be used as width or height based on the position of the tab bar)
*/