diff --git a/src/core/lv_obj_tree.h b/src/core/lv_obj_tree.h index 3cee6e66a0..9f679dd40a 100644 --- a/src/core/lv_obj_tree.h +++ b/src/core/lv_obj_tree.h @@ -1,5 +1,5 @@ /** - * @file struct _lv_obj_tree.h + * @file lv_obj_tree.h * */ @@ -224,7 +224,7 @@ void lv_obj_tree_walk(lv_obj_t * start_obj, lv_obj_tree_walk_cb_t cb, void * use * Iterate through all children of any object and print their ID. * @param start_obj start integrating from this object */ -void lv_obj_dump_tree(lv_obj_t * start_ob); +void lv_obj_dump_tree(lv_obj_t * start_obj); /********************** * MACROS diff --git a/src/display/lv_display.h b/src/display/lv_display.h index 84a4828dff..9ce81552b1 100644 --- a/src/display/lv_display.h +++ b/src/display/lv_display.h @@ -1,5 +1,5 @@ /** - * @file lv_disp.h + * @file lv_display.h * */ diff --git a/src/draw/lv_draw_image.h b/src/draw/lv_draw_image.h index 737e8b4390..fef361aa63 100644 --- a/src/draw/lv_draw_image.h +++ b/src/draw/lv_draw_image.h @@ -1,5 +1,5 @@ /** - * @file lv_draw_img.h + * @file lv_draw_image.h * */ diff --git a/src/draw/lv_draw_mask.h b/src/draw/lv_draw_mask.h index 6357647e97..e471b4c37e 100644 --- a/src/draw/lv_draw_mask.h +++ b/src/draw/lv_draw_mask.h @@ -1,10 +1,10 @@ /** - * @file lv_draw_mask_rect.h + * @file lv_draw_mask.h * */ -#ifndef LV_DRAW_MASK_RECT_H -#define LV_DRAW_MASK_RECT_H +#ifndef LV_DRAW_MASK_H +#define LV_DRAW_MASK_H #ifdef __cplusplus extern "C" { @@ -64,4 +64,4 @@ void lv_draw_mask_rect(lv_layer_t * layer, const lv_draw_mask_rect_dsc_t * dsc); } /*extern "C"*/ #endif -#endif /*LV_DRAW_MASK_RECT_H*/ +#endif /*LV_DRAW_MASK_H*/ diff --git a/src/draw/sw/blend/lv_draw_sw_blend_to_al88.h b/src/draw/sw/blend/lv_draw_sw_blend_to_al88.h index 85720ab8b4..90edb1dbab 100644 --- a/src/draw/sw/blend/lv_draw_sw_blend_to_al88.h +++ b/src/draw/sw/blend/lv_draw_sw_blend_to_al88.h @@ -1,10 +1,10 @@ /** - * @file lv_draw_sw_blend_al88.h + * @file lv_draw_sw_blend_to_al88.h * */ -#ifndef LV_DRAW_SW_BLEND_AL88_H -#define LV_DRAW_SW_BLEND_AL88_H +#ifndef LV_DRAW_SW_BLEND_TO_AL88_H +#define LV_DRAW_SW_BLEND_TO_AL88_H #ifdef __cplusplus extern "C" { @@ -42,4 +42,4 @@ void /* LV_ATTRIBUTE_FAST_MEM */ lv_draw_sw_blend_image_to_al88(_lv_draw_sw_blen } /*extern "C"*/ #endif -#endif /*LV_DRAW_SW_BLEND_AL88_H*/ +#endif /*LV_DRAW_SW_BLEND_TO_AL88_H*/ diff --git a/src/draw/sw/blend/lv_draw_sw_blend_to_argb8888.h b/src/draw/sw/blend/lv_draw_sw_blend_to_argb8888.h index cfd4316835..964991be6d 100644 --- a/src/draw/sw/blend/lv_draw_sw_blend_to_argb8888.h +++ b/src/draw/sw/blend/lv_draw_sw_blend_to_argb8888.h @@ -1,10 +1,10 @@ /** - * @file lv_draw_sw_blend_argb8888.h + * @file lv_draw_sw_blend_to_argb8888.h * */ -#ifndef LV_DRAW_SW_BLEND_ARGB8888_H -#define LV_DRAW_SW_BLEND_ARGB8888_H +#ifndef LV_DRAW_SW_BLEND_TO_ARGB8888_H +#define LV_DRAW_SW_BLEND_TO_ARGB8888_H #ifdef __cplusplus extern "C" { @@ -42,4 +42,4 @@ void /* LV_ATTRIBUTE_FAST_MEM */ lv_draw_sw_blend_image_to_argb8888(_lv_draw_sw_ } /*extern "C"*/ #endif -#endif /*LV_DRAW_SW_BLEND_ARGB8888_H*/ +#endif /*LV_DRAW_SW_BLEND_TO_ARGB8888_H*/ diff --git a/src/draw/sw/blend/lv_draw_sw_blend_to_i1.h b/src/draw/sw/blend/lv_draw_sw_blend_to_i1.h index 7a396961f6..efb852e06c 100644 --- a/src/draw/sw/blend/lv_draw_sw_blend_to_i1.h +++ b/src/draw/sw/blend/lv_draw_sw_blend_to_i1.h @@ -1,5 +1,5 @@ /** - * @file lv_draw_sw_blend_i1.h + * @file lv_draw_sw_blend_to_i1.h * */ diff --git a/src/draw/sw/blend/lv_draw_sw_blend_to_l8.h b/src/draw/sw/blend/lv_draw_sw_blend_to_l8.h index 4adab9f165..71ef1cd12a 100644 --- a/src/draw/sw/blend/lv_draw_sw_blend_to_l8.h +++ b/src/draw/sw/blend/lv_draw_sw_blend_to_l8.h @@ -1,10 +1,10 @@ /** - * @file lv_draw_sw_blend_l8.h + * @file lv_draw_sw_blend_to_l8.h * */ -#ifndef LV_DRAW_SW_BLEND_L8_H -#define LV_DRAW_SW_BLEND_L8_H +#ifndef LV_DRAW_SW_BLEND_TO_L8_H +#define LV_DRAW_SW_BLEND_TO_L8_H #ifdef __cplusplus extern "C" { @@ -42,4 +42,4 @@ void /* LV_ATTRIBUTE_FAST_MEM */ lv_draw_sw_blend_image_to_l8(_lv_draw_sw_blend_ } /*extern "C"*/ #endif -#endif /*LV_DRAW_SW_BLEND_L8_H*/ +#endif /*LV_DRAW_SW_BLEND_TO_L8_H*/ diff --git a/src/draw/sw/blend/lv_draw_sw_blend_to_rgb565.h b/src/draw/sw/blend/lv_draw_sw_blend_to_rgb565.h index c7482f9485..156428877d 100644 --- a/src/draw/sw/blend/lv_draw_sw_blend_to_rgb565.h +++ b/src/draw/sw/blend/lv_draw_sw_blend_to_rgb565.h @@ -1,10 +1,10 @@ /** - * @file lv_draw_sw_blend_rgb565.h + * @file lv_draw_sw_blend_to_rgb565.h * */ -#ifndef LV_DRAW_SW_BLEND_RGB565_H -#define LV_DRAW_SW_BLEND_RGB565_H +#ifndef LV_DRAW_SW_BLEND_TO_RGB565_H +#define LV_DRAW_SW_BLEND_TO_RGB565_H #ifdef __cplusplus extern "C" { @@ -42,4 +42,4 @@ void /* LV_ATTRIBUTE_FAST_MEM */ lv_draw_sw_blend_image_to_rgb565(_lv_draw_sw_bl } /*extern "C"*/ #endif -#endif /*LV_DRAW_SW_BLEND_RGB565_H*/ +#endif /*LV_DRAW_SW_BLEND_TO_RGB565_H*/ diff --git a/src/draw/sw/blend/lv_draw_sw_blend_to_rgb888.h b/src/draw/sw/blend/lv_draw_sw_blend_to_rgb888.h index a97a58bfed..66dc477a66 100644 --- a/src/draw/sw/blend/lv_draw_sw_blend_to_rgb888.h +++ b/src/draw/sw/blend/lv_draw_sw_blend_to_rgb888.h @@ -1,10 +1,10 @@ /** - * @file lv_draw_sw_blend_rgb888.h + * @file lv_draw_sw_blend_to_rgb888.h * */ -#ifndef LV_DRAW_SW_BLEND_RGB888_H -#define LV_DRAW_SW_BLEND_RGB888_H +#ifndef LV_DRAW_SW_BLEND_TO_RGB888_H +#define LV_DRAW_SW_BLEND_TO_RGB888_H #ifdef __cplusplus extern "C" { @@ -44,4 +44,4 @@ void /* LV_ATTRIBUTE_FAST_MEM */ lv_draw_sw_blend_image_to_rgb888(_lv_draw_sw_bl } /*extern "C"*/ #endif -#endif /*LV_DRAW_SW_BLEND_RGB888_H*/ +#endif /*LV_DRAW_SW_BLEND_TO_RGB888_H*/ diff --git a/src/draw/vg_lite/lv_draw_vg_lite.h b/src/draw/vg_lite/lv_draw_vg_lite.h index 8b5cb3b46e..1d01fd6024 100644 --- a/src/draw/vg_lite/lv_draw_vg_lite.h +++ b/src/draw/vg_lite/lv_draw_vg_lite.h @@ -1,10 +1,10 @@ /** - * @file lv_vg_lite_draw.h + * @file lv_draw_vg_lite.h * */ -#ifndef LV_VG_LITE_DRAW_H -#define LV_VG_LITE_DRAW_H +#ifndef LV_DRAW_VG_LITE_H +#define LV_DRAW_VG_LITE_H #ifdef __cplusplus extern "C" { @@ -81,4 +81,4 @@ void lv_draw_vg_lite_vector(lv_draw_unit_t * draw_unit, const lv_draw_vector_tas } /*extern "C"*/ #endif -#endif /*LV_VG_LITE_DRAW_H*/ +#endif /*LV_DRAW_VG_LITE_H*/ diff --git a/src/draw/vg_lite/lv_draw_vg_lite_type.h b/src/draw/vg_lite/lv_draw_vg_lite_type.h index a4d24d20d1..d1ba5d7ed9 100644 --- a/src/draw/vg_lite/lv_draw_vg_lite_type.h +++ b/src/draw/vg_lite/lv_draw_vg_lite_type.h @@ -69,4 +69,4 @@ struct _lv_draw_vg_lite_unit_t { } /*extern "C"*/ #endif -#endif /*LV_VG_LITE_DRAW_H*/ +#endif /*LV_DRAW_VG_LITE_TYPE_H*/ diff --git a/src/drivers/display/drm/lv_linux_drm.h b/src/drivers/display/drm/lv_linux_drm.h index a75d19586f..ee32466caa 100644 --- a/src/drivers/display/drm/lv_linux_drm.h +++ b/src/drivers/display/drm/lv_linux_drm.h @@ -1,5 +1,5 @@ /** - * @file lv_linux_drm_h + * @file lv_linux_drm.h * */ diff --git a/src/drivers/display/fb/lv_linux_fbdev.h b/src/drivers/display/fb/lv_linux_fbdev.h index c14e9734c1..2c41aec192 100644 --- a/src/drivers/display/fb/lv_linux_fbdev.h +++ b/src/drivers/display/fb/lv_linux_fbdev.h @@ -1,10 +1,10 @@ /** - * @file lv_linux_fb_dev_h + * @file lv_linux_fbdev.h * */ -#ifndef LV_LINUX_FB_DEV_H -#define LV_LINUX_FB_DEV_H +#ifndef LV_LINUX_FBDEV_H +#define LV_LINUX_FBDEV_H #ifdef __cplusplus extern "C" { @@ -49,4 +49,4 @@ void lv_linux_fbdev_set_force_refresh(lv_display_t * disp, bool enabled); } /* extern "C" */ #endif -#endif /* LV_LINUX_FB_DEV_H */ +#endif /* LV_LINUX_FBDEV_H */ diff --git a/src/drivers/nuttx/lv_nuttx_fbdev.h b/src/drivers/nuttx/lv_nuttx_fbdev.h index 994c4973b0..4310aa9c1d 100644 --- a/src/drivers/nuttx/lv_nuttx_fbdev.h +++ b/src/drivers/nuttx/lv_nuttx_fbdev.h @@ -1,5 +1,5 @@ /** - * @file lv_nuttx_fbdev_h + * @file lv_nuttx_fbdev.h * */ diff --git a/src/drivers/qnx/lv_qnx.h b/src/drivers/qnx/lv_qnx.h index c194d0bdf5..f0ec49b936 100644 --- a/src/drivers/qnx/lv_qnx.h +++ b/src/drivers/qnx/lv_qnx.h @@ -1,5 +1,5 @@ /** - * @file lv_qnx_window.h + * @file lv_qnx.h * @brief LVGL driver for the QNX Screen compositing window manager */ diff --git a/src/drivers/sdl/lv_sdl_mouse.h b/src/drivers/sdl/lv_sdl_mouse.h index 02e9b576d7..ef60685f42 100644 --- a/src/drivers/sdl/lv_sdl_mouse.h +++ b/src/drivers/sdl/lv_sdl_mouse.h @@ -1,5 +1,5 @@ /** - * @file Lv_sdl_mouse.h + * @file lv_sdl_mouse.h * */ diff --git a/src/layouts/lv_layout.h b/src/layouts/lv_layout.h index f8258b5988..4f0c62c077 100644 --- a/src/layouts/lv_layout.h +++ b/src/layouts/lv_layout.h @@ -1,10 +1,10 @@ /** - * @file lv_layouts.h + * @file lv_layout.h * */ -#ifndef LV_LAYOUTS_H -#define LV_LAYOUTS_H +#ifndef LV_LAYOUT_H +#define LV_LAYOUT_H #ifdef __cplusplus extern "C" { @@ -82,4 +82,4 @@ void _lv_layout_apply(lv_obj_t * obj); } /*extern "C"*/ #endif -#endif /*LV_LAYOUTS_H*/ +#endif /*LV_LAYOUT_H*/ diff --git a/src/libs/barcode/lv_barcode.h b/src/libs/barcode/lv_barcode.h index 343e18bf86..664f38bb98 100644 --- a/src/libs/barcode/lv_barcode.h +++ b/src/libs/barcode/lv_barcode.h @@ -1,5 +1,5 @@ /** - * @file lv_barcode.c + * @file lv_barcode.h * */ diff --git a/src/libs/qrcode/lv_qrcode.h b/src/libs/qrcode/lv_qrcode.h index aed84fd7c6..6bf6d2c81d 100644 --- a/src/libs/qrcode/lv_qrcode.h +++ b/src/libs/qrcode/lv_qrcode.h @@ -1,5 +1,5 @@ /** - * @file lv_qrcode + * @file lv_qrcode.h * */ diff --git a/src/others/gridnav/lv_gridnav.h b/src/others/gridnav/lv_gridnav.h index 50fff32700..996985d7f4 100644 --- a/src/others/gridnav/lv_gridnav.h +++ b/src/others/gridnav/lv_gridnav.h @@ -1,43 +1,3 @@ -/** - * @file lv_templ.c - * - */ - -/********************* - * INCLUDES - *********************/ - -/********************* - * DEFINES - *********************/ - -/********************** - * TYPEDEFS - **********************/ - -/*This typedef exists purely to keep -Wpedantic happy when the file is empty.*/ -/*It can be removed.*/ -typedef int _keep_pedantic_happy; - -/********************** - * STATIC PROTOTYPES - **********************/ - -/********************** - * STATIC VARIABLES - **********************/ - -/********************** - * MACROS - **********************/ - -/********************** - * GLOBAL FUNCTIONS - **********************/ - -/********************** - * STATIC FUNCTIONS - **********************/ /** * @file lv_gridnav.h * diff --git a/src/stdlib/lv_string.h b/src/stdlib/lv_string.h index 6cbb4e33cb..10aee500f0 100644 --- a/src/stdlib/lv_string.h +++ b/src/stdlib/lv_string.h @@ -1,5 +1,5 @@ /** - * @file lv_stringn.h + * @file lv_string.h * */ diff --git a/src/tick/lv_tick.h b/src/tick/lv_tick.h index eb53fe8d98..ef65b967ff 100644 --- a/src/tick/lv_tick.h +++ b/src/tick/lv_tick.h @@ -1,10 +1,10 @@ /** - * @file lv_hal_tick.h + * @file lv_tick.h * Provide access to the system tick with 1 millisecond resolution */ -#ifndef LV_HAL_TICK_H -#define LV_HAL_TICK_H +#ifndef LV_TICK_H +#define LV_TICK_H #ifdef __cplusplus extern "C" { @@ -89,4 +89,4 @@ void lv_delay_set_cb(lv_delay_cb_t cb); } /*extern "C"*/ #endif -#endif /*LV_HAL_TICK_H*/ +#endif /*LV_TICK_H*/ diff --git a/src/widgets/animimage/lv_animimage.h b/src/widgets/animimage/lv_animimage.h index 87df815404..0e88a26352 100644 --- a/src/widgets/animimage/lv_animimage.h +++ b/src/widgets/animimage/lv_animimage.h @@ -1,10 +1,10 @@ /** - * @file lv_animimg.h + * @file lv_animimage.h * */ -#ifndef LV_ANIM_IMAGE_H -#define LV_ANIM_IMAGE_H +#ifndef LV_ANIMIMAGE_H +#define LV_ANIMIMAGE_H #ifdef __cplusplus extern "C" { @@ -133,4 +133,4 @@ uint32_t lv_animimg_get_repeat_count(lv_obj_t * img); } /* extern "C" */ #endif -#endif /*LV_ANIM_IMAGE_H*/ +#endif /*LV_ANIMIMAGE_H*/ diff --git a/src/widgets/button/lv_button.h b/src/widgets/button/lv_button.h index 08ba1cdbc9..85803e6f5a 100644 --- a/src/widgets/button/lv_button.h +++ b/src/widgets/button/lv_button.h @@ -1,5 +1,5 @@ /** - * @file lv_btn.h + * @file lv_button.h * */ diff --git a/src/widgets/buttonmatrix/lv_buttonmatrix.h b/src/widgets/buttonmatrix/lv_buttonmatrix.h index 64c0d1b55f..7ceaf29b26 100644 --- a/src/widgets/buttonmatrix/lv_buttonmatrix.h +++ b/src/widgets/buttonmatrix/lv_buttonmatrix.h @@ -1,5 +1,5 @@ /** - * @file lv_btnmatrix.h + * @file lv_buttonmatrix.h * */ @@ -142,7 +142,6 @@ void lv_buttonmatrix_set_button_ctrl_all(lv_obj_t * obj, lv_buttonmatrix_ctrl_t * Clear the attributes of all buttons of a button matrix * @param obj pointer to a button matrix object * @param ctrl attribute(s) to set from `lv_buttonmatrix_ctrl_t`. Values can be ORed. - * @param en true: set the attributes; false: clear the attributes */ void lv_buttonmatrix_clear_button_ctrl_all(lv_obj_t * obj, lv_buttonmatrix_ctrl_t ctrl); diff --git a/src/widgets/checkbox/lv_checkbox.h b/src/widgets/checkbox/lv_checkbox.h index 1a0b3df1d9..25ba359468 100644 --- a/src/widgets/checkbox/lv_checkbox.h +++ b/src/widgets/checkbox/lv_checkbox.h @@ -1,5 +1,5 @@ /** - * @file lv_cb.h + * @file lv_checkbox.h * */ diff --git a/src/widgets/image/lv_image.h b/src/widgets/image/lv_image.h index a15a45d198..8c45ee9414 100644 --- a/src/widgets/image/lv_image.h +++ b/src/widgets/image/lv_image.h @@ -1,5 +1,5 @@ /** - * @file lv_img.h + * @file lv_image.h * */ @@ -39,20 +39,20 @@ extern "C" { */ typedef struct { lv_obj_t obj; - const void * src; /**< Image source: Pointer to an array or a file or a symbol*/ + const void * src; /**< Image source: Pointer to an array or a file or a symbol*/ const lv_image_dsc_t * bitmap_mask_src; /**< Pointer to an A8 bitmap mask */ lv_point_t offset; - int32_t w; /**< Width of the image (Handled by the library)*/ - int32_t h; /**< Height of the image (Handled by the library)*/ - uint32_t rotation; /**< Rotation angle of the image*/ - uint32_t scale_x; /**< 256 means no zoom, 512 double size, 128 half size*/ - uint32_t scale_y; /**< 256 means no zoom, 512 double size, 128 half size*/ - lv_point_t pivot; /**< Rotation center of the image*/ + int32_t w; /**< Width of the image (Handled by the library)*/ + int32_t h; /**< Height of the image (Handled by the library)*/ + uint32_t rotation; /**< Rotation angle of the image*/ + uint32_t scale_x; /**< 256 means no zoom, 512 double size, 128 half size*/ + uint32_t scale_y; /**< 256 means no zoom, 512 double size, 128 half size*/ + lv_point_t pivot; /**< Rotation center of the image*/ uint32_t src_type : 2; /**< See: lv_image_src_t*/ uint32_t cf : 5; /**< Color format from `lv_color_format_t`*/ uint32_t antialias : 1; /**< Apply anti-aliasing in transformations (rotate, zoom)*/ - uint32_t align: 4; /**< Image size mode when image size and object size is different. See `lv_image_align_t`*/ - uint32_t blend_mode: 4; /**< Element of `lv_blend_mode_t`*/ + uint32_t align: 4; /**< Image size mode when image size and object size is different. See lv_image_align_t*/ + uint32_t blend_mode: 4; /**< Element of `lv_blend_mode_t`*/ } lv_image_t; LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_image_class; @@ -83,7 +83,7 @@ typedef uint8_t lv_image_align_t; #endif /*DOXYGEN*/ #if LV_USE_OBJ_PROPERTY -enum { +enum _lv_image_property_t { LV_PROPERTY_ID(IMAGE, SRC, LV_PROPERTY_TYPE_IMGSRC, 0), LV_PROPERTY_ID(IMAGE, OFFSET_X, LV_PROPERTY_TYPE_INT, 1), LV_PROPERTY_ID(IMAGE, OFFSET_Y, LV_PROPERTY_TYPE_INT, 2), @@ -171,39 +171,39 @@ static inline void _lv_image_set_pivot(lv_obj_t * obj, lv_point_t * pivot) /** * Set the zoom factor of the image. * Note that indexed and alpha only images can't be transformed. - * @param img pointer to an image object - * @param zoom the zoom factor. - * @example 256 or LV_ZOOM_IMAGE_NONE for no zoom - * @example <256: scale down - * @example >256 scale up - * @example 128 half size - * @example 512 double size + * @param obj pointer to an image object + * @param zoom the zoom factor. Example values: + * - 256 or LV_ZOOM_IMAGE_NONE: no zoom + * - <256: scale down + * - >256: scale up + * - 128: half size + * - 512: double size */ void lv_image_set_scale(lv_obj_t * obj, uint32_t zoom); /** * Set the horizontal zoom factor of the image. * Note that indexed and alpha only images can't be transformed. - * @param img pointer to an image object - * @param zoom the zoom factor. - * @example 256 or LV_ZOOM_IMAGE_NONE for no zoom - * @example <256: scale down - * @example >256 scale up - * @example 128 half size - * @example 512 double size + * @param obj pointer to an image object + * @param zoom the zoom factor. Example values: + * - 256 or LV_ZOOM_IMAGE_NONE: no zoom + * - <256: scale down + * - >256: scale up + * - 128: half size + * - 512: double size */ void lv_image_set_scale_x(lv_obj_t * obj, uint32_t zoom); /** * Set the vertical zoom factor of the image. * Note that indexed and alpha only images can't be transformed. - * @param img pointer to an image object - * @param zoom the zoom factor. - * @example 256 or LV_ZOOM_IMAGE_NONE for no zoom - * @example <256: scale down - * @example >256 scale up - * @example 128 half size - * @example 512 double size + * @param obj pointer to an image object + * @param zoom the zoom factor. Example values: + * - 256 or LV_ZOOM_IMAGE_NONE: no zoom + * - <256: scale down + * - >256: scale up + * - 128: half size + * - 512: double size */ void lv_image_set_scale_y(lv_obj_t * obj, uint32_t zoom); @@ -328,7 +328,7 @@ bool lv_image_get_antialias(lv_obj_t * obj); /** * Get the size mode of the image * @param obj pointer to an image object - * @return element of @ref lv_image_align_t + * @return element of `lv_image_align_t` */ lv_image_align_t lv_image_get_inner_align(lv_obj_t * obj); diff --git a/src/widgets/label/lv_label.h b/src/widgets/label/lv_label.h index f2d4463efa..2f1954152b 100644 --- a/src/widgets/label/lv_label.h +++ b/src/widgets/label/lv_label.h @@ -114,7 +114,11 @@ void lv_label_set_text(lv_obj_t * obj, const char * text); * Set a new formatted text for a label. Memory will be allocated to store the text by the label. * @param obj pointer to a label object * @param fmt `printf`-like format - * @example lv_label_set_text_fmt(label1, "%d user", user_num); + * + * Example: + * @code + * lv_label_set_text_fmt(label1, "%d user", user_num); + * @endcode */ void lv_label_set_text_fmt(lv_obj_t * obj, const char * fmt, ...) LV_FORMAT_ATTRIBUTE(2, 3); diff --git a/src/widgets/msgbox/lv_msgbox.h b/src/widgets/msgbox/lv_msgbox.h index b7413ee7eb..10040f0ff8 100644 --- a/src/widgets/msgbox/lv_msgbox.h +++ b/src/widgets/msgbox/lv_msgbox.h @@ -1,5 +1,5 @@ /** - * @file lv_mbox.h + * @file lv_msgbox.h * */ @@ -80,7 +80,7 @@ lv_obj_t * lv_msgbox_add_header_button(lv_obj_t * obj, const void * icon); /** * Add a text to the content area of message box. Multiply texts will be created below each other. * @param obj pointer to a message box - * @param icon the icon of the button + * @param text text to add * @return the created button */ lv_obj_t * lv_msgbox_add_text(lv_obj_t * obj, const char * text); @@ -130,13 +130,13 @@ lv_obj_t * lv_msgbox_get_title(lv_obj_t * obj); /** * Close a message box - * @param obj pointer to a message box + * @param mbox pointer to a message box */ void lv_msgbox_close(lv_obj_t * mbox); /** * Close a message box in the next call of the message box - * @param obj pointer to a message box + * @param mbox pointer to a message box */ void lv_msgbox_close_async(lv_obj_t * mbox);