Embedded/lvgl
1
0
Fork 0
mirror of https://github.com/lvgl/lvgl.git synced 2025-01-28 07:03:00 +08:00
Code Issues Projects Releases Wiki Activity

fix(doc): remove ':' from @param (#2137)

Browse Source
This commit is contained in:
Xiang Xiao 2021-03-14 06:02:16 -07:00 committed by GitHub
parent 4516018ce7
commit 460b227b83
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 122 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/extra/layouts/flex/lv_flex.h
View File

@ -71,30 +71,30 @@ typedef struct {
/**
* Initialize a felx layout the default values
* @param flex: pointer to a flex layout descriptor
* @param flex pointer to a flex layout descriptor
*/
void lv_flex_init(lv_flex_t * flex);
/**
* Set hot the item should flow
* @param flex: pointer to a flex layout descriptor
* @param flow: an element of `lv_flex_flow_t`.
* @param flex pointer to a flex layout descriptor
* @param flow an element of `lv_flex_flow_t`.
*/
void lv_flex_set_flow(lv_flex_t * flex, lv_flex_flow_t flow);
/**
* Set how to place (where to align) the items an tracks
* @param flex pointer: to a flex layout descriptor
* @param main_place: where to place the items on main axis (in their track). Any value of `lv_flex_place_t`.
* @param cross_place: where to place the item in their track on the cross axis. `LV_FLEX_PLACE_START/END/CENTER`
* @param track_place: where to place the tracks in the cross direction. Any value of `lv_flex_place_t`.
* @param main_place where to place the items on main axis (in their track). Any value of `lv_flex_place_t`.
* @param cross_place where to place the item in their track on the cross axis. `LV_FLEX_PLACE_START/END/CENTER`
* @param track_place where to place the tracks in the cross direction. Any value of `lv_flex_place_t`.
*/
void lv_flex_set_place(lv_flex_t * flex, lv_flex_place_t main_place, lv_flex_place_t cross_place, lv_flex_place_t track_cross_place);
/**
* Sets the width or height (on main axis) to grow the object in order fill the free space
* @param obj: pointer to an object. The parent must have flex layout else nothing will happen.
* @param grow: a value to set how much free space to take proportionally to other growing items.
* @param obj pointer to an object. The parent must have flex layout else nothing will happen.
* @param grow a value to set how much free space to take proportionally to other growing items.
*/
void lv_obj_set_flex_grow(struct _lv_obj_t * obj, uint8_t grow);

24
src/extra/layouts/grid/lv_grid.h
View File

@ -65,17 +65,17 @@ typedef struct {
/**
* Initialize a grid layout the default values
* @param grid: pointer to a grid layout descriptor
* @param grid pointer to a grid layout descriptor
*/
void lv_grid_init(lv_grid_t * grid);
/**
* Set the number of rows and columns and their sizes
* @param grid: pointer to a grid layout descriptor
* @param col_dsc: an array with the column widths
* @param col_cnt: number of columns (max 16)
* @param row_dsc: an array with the row heights
* @param row_cnt: number of rows (max 16)
* @param grid pointer to a grid layout descriptor
* @param col_dsc an array with the column widths
* @param col_cnt number of columns (max 16)
* @param row_dsc an array with the row heights
* @param row_cnt number of rows (max 16)
* @note `LV_GRID_FR(x)` can be used as track size.
*/
void lv_grid_set_template(lv_grid_t * grid, const lv_coord_t * col_dsc, uint8_t col_cnt, const lv_coord_t * row_dsc, uint8_t row_cnt);
@ -90,13 +90,13 @@ void lv_grid_set_place(lv_grid_t * grid, uint8_t col_place, uint8_t row_place);
/**
* Set the cell of an object. The object's parent needs to have grid layout, else nothing will happen
* @param obj: pointer to an object
* @param hor_place: the vertical alignment in the cell. `LV_GRID_START/END/CENTER/STRETCH`
* @param col_pos: column ID
* @param col_span: number of columns to take (>= 1)
* @param obj pointer to an object
* @param hor_place the vertical alignment in the cell. `LV_GRID_START/END/CENTER/STRETCH`
* @param col_pos column ID
* @param col_span number of columns to take (>= 1)
* @param ver_place the horizontal alignment in the cell. `LV_GRID_START/END/CENTER/STRETCH`
* @param row_pos: row ID
* @param row_span: number of rows to take (>= 1)
* @param row_pos row ID
* @param row_span number of rows to take (>= 1)
*/
void lv_obj_set_grid_cell(struct _lv_obj_t * obj, lv_grid_place_t hor_place, uint8_t col_pos, uint8_t col_span,
lv_grid_place_t ver_place, uint8_t row_pos, uint8_t row_span);

8
src/lv_core/lv_group.c
View File

@ -317,7 +317,7 @@ void lv_group_set_focus_cb(lv_group_t * group, lv_group_focus_cb_t focus_cb)
/**
* Manually set the current mode (edit or navigate).
* @param group pointer to group
* @param edit: true: edit mode; false: navigate mode
* @param edit true: edit mode; false: navigate mode
*/
void lv_group_set_editing(lv_group_t * group, bool edit)
{
@ -341,7 +341,7 @@ void lv_group_set_editing(lv_group_t * group, bool edit)
/**
* Set the `click_focus` attribute. If enabled then the object will be focused then it is clicked.
* @param group pointer to group
* @param en: true: enable `click_focus`
* @param en true: enable `click_focus`
*/
void lv_group_set_click_focus(lv_group_t * group, bool en)
{
@ -356,7 +356,7 @@ void lv_group_set_refocus_policy(lv_group_t * group, lv_group_refocus_policy_t p
/**
* Set whether focus next/prev will allow wrapping from first->last or last->first.
* @param group pointer to group
* @param en: true: enable `wrap`
* @param en true: enable `wrap`
*/
void lv_group_set_wrap(lv_group_t * group, bool en)
{
@ -412,7 +412,7 @@ bool lv_group_get_click_focus(const lv_group_t * group)
/**
* Get whether focus next/prev will allow wrapping from first->last or last->first object.
* @param group pointer to group
* @param en: true: wrapping enabled; false: wrapping disabled
* @param en true: wrapping enabled; false: wrapping disabled
*/
bool lv_group_get_wrap(lv_group_t * group)
{

8
src/lv_core/lv_group.h
View File

@ -168,21 +168,21 @@ void lv_group_set_refocus_policy(lv_group_t * group, lv_group_refocus_policy_t p
/**
* Manually set the current mode (edit or navigate).
* @param group pointer to group
* @param edit: true: edit mode; false: navigate mode
* @param edit true: edit mode; false: navigate mode
*/
void lv_group_set_editing(lv_group_t * group, bool edit);
/**
* Set the `click_focus` attribute. If enabled then the object will be focused then it is clicked.
* @param group pointer to group
* @param en: true: enable `click_focus`
* @param en true: enable `click_focus`
*/
void lv_group_set_click_focus(lv_group_t * group, bool en);
/**
* Set whether focus next/prev will allow wrapping from first->last or last->first object.
* @param group pointer to group
* @param en: true: wrapping enabled; false: wrapping disabled
* @param en true: wrapping enabled; false: wrapping disabled
*/
void lv_group_set_wrap(lv_group_t * group, bool en);
@ -217,7 +217,7 @@ bool lv_group_get_click_focus(const lv_group_t * group);
/**
* Get whether focus next/prev will allow wrapping from first->last or last->first object.
* @param group pointer to group
* @param en: true: wrapping enabled; false: wrapping disabled
* @param en true: wrapping enabled; false: wrapping disabled
*/
bool lv_group_get_wrap(lv_group_t * group);

36
src/lv_core/lv_obj_draw.h
View File

@ -73,9 +73,9 @@ typedef lv_draw_res_t (*lv_draw_cb_t)(struct _lv_obj_t * obj, const lv_area_t *
/**
* Initialize a rectangle draw descriptor from an object's styles in its current state
* @param obj: pointer to an object
* @param part: part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc: the descriptor the initialize.
* @param obj pointer to an object
* @param part part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc the descriptor the initialize.
* If an `..._opa` filed is set to `LV_OPA_TRANSP` the related properties won't be initialized.
* Should be initialized with `lv_draw_rect_dsc_init(draw_dsc)`.
* @note Only the relevant fields will be set.
@ -85,9 +85,9 @@ void lv_obj_init_draw_rect_dsc(struct _lv_obj_t * obj, uint8_t part, lv_draw_rec
/**
* Initialize a label draw descriptor from an object's styles in its current state
* @param obj: pointer to an object
* @param part: part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc: the descriptor the initialize.
* @param obj pointer to an object
* @param part part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc the descriptor the initialize.
* If the `opa` filed is set to or the property is equal to `LV_OPA_TRANSP` the rest won't be initialized.
* Should be initialized with `lv_draw_label_dsc_init(draw_dsc)`.
*/
@ -95,9 +95,9 @@ void lv_obj_init_draw_label_dsc(struct _lv_obj_t * obj, uint8_t part, lv_draw_la
/**
* Initialize an image draw descriptor from an object's styles in its current state
* @param obj: pointer to an object
* @param part: part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc: the descriptor the initialize.
* @param obj pointer to an object
* @param part part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc the descriptor the initialize.
* Should be initialized with `lv_draw_image_dsc_init(draw_dsc)`.
*/
void lv_obj_init_draw_img_dsc(struct _lv_obj_t * obj, uint8_t part, lv_draw_img_dsc_t * draw_dsc);
@ -105,18 +105,18 @@ void lv_obj_init_draw_img_dsc(struct _lv_obj_t * obj, uint8_t part, lv_draw_img_
/**
* Initialize a line draw descriptor from an object's styles in its current state
* @param obj: pointer to an object
* @param part: part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc: the descriptor the initialize.
* @param obj pointer to an object
* @param part part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc the descriptor the initialize.
* Should be initialized with `lv_draw_line_dsc_init(draw_dsc)`.
*/
void lv_obj_init_draw_line_dsc(struct _lv_obj_t * obj, uint8_t part, lv_draw_line_dsc_t * draw_dsc);
/**
* Initialize an arc draw descriptor from an object's styles in its current state
* @param obj: pointer to an object
* @param part: part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc: the descriptor the initialize.
* @param obj pointer to an object
* @param part part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc the descriptor the initialize.
* Should be initialized with `lv_draw_arc_dsc_init(draw_dsc)`.
*/
void lv_obj_init_draw_arc_dsc(struct _lv_obj_t * obj, uint8_t part, lv_draw_arc_dsc_t * draw_dsc);
@ -131,15 +131,15 @@ lv_coord_t lv_obj_calculate_ext_draw_size(struct _lv_obj_t * obj, uint8_t part);
/**
* Initialize a draw hook.
* @param hook_dsc: pointer to a raw hook. Later it should be passed as parameter to an `LV_EEVNT_DRAW_PART_BEGIN/END` event.
* @param clip_area: the current clip area of the drawing
* @param hook_dsc pointer to a raw hook. Later it should be passed as parameter to an `LV_EEVNT_DRAW_PART_BEGIN/END` event.
* @param clip_area the current clip area of the drawing
*/
void lv_obj_draw_hook_dsc_init(lv_obj_draw_hook_dsc_t * hook_dsc, const lv_area_t * clip_area);
/**
* Send a 'LV_SIGNAL_REFR_EXT_DRAW_SIZE' signal to the object to refresh the value of the extended draw size.
* The result will be saved in `obj`.
* @param obj: pointer to an object
* @param obj pointer to an object
*/
void lv_obj_refresh_ext_draw_size(struct _lv_obj_t * obj);

12
src/lv_core/lv_obj_style.c
View File

@ -398,9 +398,9 @@ void lv_obj_fade_out(lv_obj_t * obj, uint32_t time, uint32_t delay)
/**
* Get the local style of an object for a given part and for a given state.
* If the local style for the part-state pair doesn't exist allocate and return it.
* @param obj: pointer to an object
* @param part: the part in whose local style to get
* @param state: the state in whose local style to get
* @param obj pointer to an object
* @param part the part in whose local style to get
* @param state the state in whose local style to get
* @return pointer to the local style
*/
static lv_style_t * get_local_style(lv_obj_t * obj, uint32_t part, uint32_t state)
@ -437,9 +437,9 @@ static lv_style_t * get_local_style(lv_obj_t * obj, uint32_t part, uint32_t stat
/**
* Get the transition style of an object for a given part and for a given state.
* If the transition style for the part-state pair doesn't exist allocate and return it.
* @param obj: pointer to an object
* @param part: the part in whose local style to get
* @param state: the state in whose local style to get
* @param obj pointer to an object
* @param part the part in whose local style to get
* @param state the state in whose local style to get
* @return pointer to the transition style
*/
static lv_obj_style_t * get_trans_style(lv_obj_t * obj, uint32_t part)

22
src/lv_core/lv_obj_tree.h
View File

@ -65,8 +65,8 @@ void lv_obj_del_async(struct _lv_obj_t * obj);
/**
* Move the parent of an object. The relative coordinates will be kept.
*
* @param obj: pointer to an object whose parent needs to be changed
* @param parent: pointer to the new parent
* @param obj pointer to an object whose parent needs to be changed
* @param parent pointer to the new parent
*/
void lv_obj_set_parent(struct _lv_obj_t * obj, struct _lv_obj_t * parent);
@ -74,7 +74,7 @@ void lv_obj_set_parent(struct _lv_obj_t * obj, struct _lv_obj_t * parent);
* Move the object to the foreground.
* It will look like if it was created as the last child of its parent.
* It also means it can cover any of the siblings.
* @param obj:pointer to an object
* @param obj pointer to an object
*/
void lv_obj_move_foreground(struct _lv_obj_t * obj);
@ -82,35 +82,35 @@ void lv_obj_move_foreground(struct _lv_obj_t * obj);
* Move the object to the background.
* It will look like if it was created as the first child of its parent.
* It also means any of the siblings can cover the object.
* @param obj:pointer to an object
* @param obj pointer to an object
*/
void lv_obj_move_background(struct _lv_obj_t * obj);
/**
* Get the screen of an object
* @param obj: pointer to an object
* @param obj pointer to an object
* @return pointer to the obejct's screen
*/
struct _lv_obj_t * lv_obj_get_screen(const struct _lv_obj_t * obj);
/**
* Get the display of the object
* @param obj: pointer to an object
* @param obj pointer to an object
* @return pointer to the obejct's display
*/
lv_disp_t * lv_obj_get_disp(const struct _lv_obj_t * obj);
/**
* Get the parent of an object
* @param obj: pointer to an object
* @param obj pointer to an object
* @return the parent of the object. (NULL if `obj` was a screen)
*/
struct _lv_obj_t * lv_obj_get_parent(const struct _lv_obj_t * obj);
/**
* Get the child of an object by the child's index.
* @param obj: pointer to an object whose child should be get
* @param id: the index of the child.
* @param obj pointer to an object whose child should be get
* @param id the index of the child.
* 0: the oldest (firstly created) child
* 1: the second oldest
* child count-1: the youngest
@ -122,14 +122,14 @@ struct _lv_obj_t * lv_obj_get_child(const struct _lv_obj_t * obj, int32_t id);
/**
* Get the number of children
* @param obj: pointer to an object
* @param obj pointer to an object
* @return the number of children
*/
uint32_t lv_obj_get_child_cnt(const struct _lv_obj_t * obj);
/**
* Get the index of a child.
* @param obj: pointer to an obejct
* @param obj pointer to an obejct
* @return the child index of the object.
* E.g. 0: the oldest (firstly created child)
*/

2
src/lv_draw/lv_draw_mask.c
View File

@ -367,7 +367,7 @@ void lv_draw_mask_angle_init(lv_draw_mask_angle_param_t * param, lv_coord_t vert
* @param param param pointer to a `lv_draw_mask_param_t` to initialize
* @param rect coordinates of the rectangle to affect (absolute coordinates)
* @param radius radius of the rectangle
* @param inv: true: keep the pixels inside the rectangle; keep the pixels outside of the rectangle
* @param inv true: keep the pixels inside the rectangle; keep the pixels outside of the rectangle
*/
void lv_draw_mask_radius_init(lv_draw_mask_radius_param_t * param, const lv_area_t * rect, lv_coord_t radius, bool inv)
{

2
src/lv_draw/lv_draw_mask.h
View File

@ -286,7 +286,7 @@ void lv_draw_mask_angle_init(lv_draw_mask_angle_param_t * param, lv_coord_t vert
* @param param param pointer to a `lv_draw_mask_param_t` to initialize
* @param rect coordinates of the rectangle to affect (absolute coordinates)
* @param radius radius of the rectangle
* @param inv: true: keep the pixels inside the rectangle; keep the pixels outside of the rectangle
* @param inv true: keep the pixels inside the rectangle; keep the pixels outside of the rectangle
*/
void lv_draw_mask_radius_init(lv_draw_mask_radius_param_t * param, const lv_area_t * rect, lv_coord_t radius, bool inv);

2
src/lv_misc/lv_math.c
View File

@ -103,7 +103,7 @@ uint32_t lv_bezier3(uint32_t t, uint32_t u0, uint32_t u1, uint32_t u2, uint32_t
* Get the square root of a number
* @param x integer which square root should be calculated
* @param q store the result here. q->i: integer part, q->f: fractional part in 1/256 unit
* @param mask: optional to skip some iterations if the magnitude of the root is known.
* @param mask optional to skip some iterations if the magnitude of the root is known.
* Set to 0x8000 by default.
* If root < 16: mask = 0x80
* If root < 256: mask = 0x800

2
src/lv_misc/lv_math.h
View File

@ -78,7 +78,7 @@ uint16_t lv_atan2(int x, int y);
* Get the square root of a number
* @param x integer which square root should be calculated
* @param q store the result here. q->i: integer part, q->f: fractional part in 1/256 unit
* @param mask: optional to skip some iterations if the magnitude of the root is known.
* @param mask optional to skip some iterations if the magnitude of the root is known.
* Set to 0x8000 by default.
* If root < 16: mask = 0x80
* If root < 256: mask = 0x800

38
src/lv_misc/lv_style.h
View File

@ -267,7 +267,7 @@ typedef struct {
/**
* Initialize a style
* @param style: pointer to a style to initialize
* @param style pointer to a style to initialize
* @note Do not call `lv_style_init` on styles that are already have some properties
* because this function won't free the used memory just set a default state for the style.
* In other words be sure to initialize styles only once!
@ -276,7 +276,7 @@ void lv_style_init(lv_style_t * style);
/**
* Clear all properties from a style and free all allocated memories.
* @param style: pointer to a style
* @param style pointer to a style
*/
void lv_style_reset(lv_style_t * style);
@ -297,8 +297,8 @@ lv_style_prop_t lv_style_register_prop(void);
/**
* Remove a property from a style
* @param style: pointer to a style
* @param prop: a style property ORed with a state.
* @param style pointer to a style
* @param prop a style property ORed with a state.
* @return true: the property was found and removed; false: the property wasn't found
*/
bool lv_style_remove_prop(lv_style_t * style, lv_style_prop_t prop);
@ -307,17 +307,17 @@ bool lv_style_remove_prop(lv_style_t * style, lv_style_prop_t prop);
* Set the value of property in a style.
* This function shouldn't be used directly by the user.
* Instead use `lv_style_set_<prop_name>()`. E.g. `lv_style_set_bg_color()`
* @param style: pointer to style
* @param prop: the ID of a property (e.g. `LV_STLYE_BG_COLOR`)
* @param value: `lv_style_value_t` variable in which a filed is set according to the type of `prop`
* @param style pointer to style
* @param prop the ID of a property (e.g. `LV_STLYE_BG_COLOR`)
* @param value `lv_style_value_t` variable in which a filed is set according to the type of `prop`
*/
void lv_style_set_prop(lv_style_t * style, lv_style_prop_t prop, lv_style_value_t value);
/**
* Get the value of a property
* @param style: pointer to a style
* @param prop: the ID of a property
* @param value: pointer to a `lv_style_value_t` variable to store the value
* @param style pointer to a style
* @param prop the ID of a property
* @param value pointer to a `lv_style_value_t` variable to store the value
* @return false: the property wsn't found in the style (`value` is unchanged)
* true: the property was fond, and `value` is set accordingly
* @note For performance reasons there are no sanity check on `style`
@ -327,9 +327,9 @@ bool lv_style_get_prop(lv_style_t * style, lv_style_prop_t prop, lv_style_value_
/**
* Get the value of a property
* @param style: pointer to a style
* @param prop: the ID of a property
* @param value: pointer to a `lv_style_value_t` variable to store the value
* @param style pointer to a style
* @param prop the ID of a property
* @param value pointer to a `lv_style_value_t` variable to store the value
* @return false: the property wsn't found in the style (`value` is unchanged)
* true: the property was fond, and `value` is set accordingly
* @note For performance reasons there are no sanity check on `style`
@ -359,11 +359,11 @@ static inline bool lv_style_get_prop_inlined(lv_style_t * style, lv_style_prop_t
/**
* Initialize a transition descriptor.
* @param tr: pointer to a transition descriptor to initialize
* @param props: an array with the properties to transition. The last element must be zero.
* @param path: and animation path. If `NULL` a default liner path will be used.
* @param time: duration of the transition in [ms]
* @param delay: delay before the transition in [ms]
* @param tr pointer to a transition descriptor to initialize
* @param props an array with the properties to transition. The last element must be zero.
* @param path and animation path. If `NULL` a default liner path will be used.
* @param time duration of the transition in [ms]
* @param delay delay before the transition in [ms]
* @example
* const static lv_style_prop_t trans_props[] = { LV_STYLE_BG_OPA, LV_STYLE_BG_COLOR, 0 };
* static lv_style_transition_dsc_t trans1;
@ -374,7 +374,7 @@ void lv_style_transition_dsc_init(lv_style_transition_dsc_t * tr, const lv_style
/**
* Get the default value of a property
* @param prop: the ID of a property
* @param prop the ID of a property
* @return the default value
*/
lv_style_value_t lv_style_prop_get_default(lv_style_prop_t prop);

2
src/lv_misc/lv_timer.c
View File

@ -243,7 +243,7 @@ void lv_timer_reset(lv_timer_t * timer)
/**
* Enable or disable the whole lv_timer handling
* @param en: true: lv_timer handling is running, false: lv_timer handling is suspended
* @param en true: lv_timer handling is running, false: lv_timer handling is suspended
*/
void lv_timer_enable(bool en)
{

2
src/lv_misc/lv_timer.h
View File

@ -136,7 +136,7 @@ void lv_timer_reset(lv_timer_t * timer);
/**
* Enable or disable the whole lv_timer handling
* @param en: true: lv_timer handling is running, false: lv_timer handling is suspended
* @param en true: lv_timer handling is running, false: lv_timer handling is suspended
*/
void lv_timer_enable(bool en);

64
src/lv_widgets/lv_canvas.h
View File

@ -167,68 +167,68 @@ void lv_canvas_fill_bg(lv_obj_t * canvas, lv_color_t color, lv_opa_t opa);
/**
* Draw a rectangle on the canvas
* @param canvas: pointer to a canvas object
* @param x: left coordinate of the rectangle
* @param y: top coordinate of the rectangle
* @param w: width of the rectangle
* @param h: height of the rectangle
* @param draw_dsc: descriptor of the rectangle
* @param canvas pointer to a canvas object
* @param x left coordinate of the rectangle
* @param y top coordinate of the rectangle
* @param w width of the rectangle
* @param h height of the rectangle
* @param draw_dsc descriptor of the rectangle
*/
void lv_canvas_draw_rect(lv_obj_t * canvas, lv_coord_t x, lv_coord_t y, lv_coord_t w, lv_coord_t h,
const lv_draw_rect_dsc_t * draw_dsc);
/**
* Draw a text on the canvas.
* @param canvas: pointer to a canvas object
* @param x: left coordinate of the text
* @param y: top coordinate of the text
* @param max_w: max width of the text. The text will be wrapped to fit into this size
* @param draw_dsc: pointer to a valid label descriptor `lv_draw_label_dsc_t`
* @param txt: text to display
* @param canvas pointer to a canvas object
* @param x left coordinate of the text
* @param y top coordinate of the text
* @param max_w max width of the text. The text will be wrapped to fit into this size
* @param draw_dsc pointer to a valid label descriptor `lv_draw_label_dsc_t`
* @param txt text to display
*/
void lv_canvas_draw_text(lv_obj_t * canvas, lv_coord_t x, lv_coord_t y, lv_coord_t max_w,
lv_draw_label_dsc_t * draw_dsc, const char * txt);
/**
* Draw an image on the canvas
* @param canvas: pointer to a canvas object
* @param x: left coordinate of the image
* @param y: top coordinate of the image
* @param src: image source. Can be a pointer an `lv_img_dsc_t` variable or a path an image.
* @param draw_dsc: pointer to a valid label descriptor `lv_draw_img_dsc_t`
* @param canvas pointer to a canvas object
* @param x left coordinate of the image
* @param y top coordinate of the image
* @param src image source. Can be a pointer an `lv_img_dsc_t` variable or a path an image.
* @param draw_dsc pointer to a valid label descriptor `lv_draw_img_dsc_t`
*/
void lv_canvas_draw_img(lv_obj_t * canvas, lv_coord_t x, lv_coord_t y, const void * src,
const lv_draw_img_dsc_t * draw_dsc);
/**
* Draw a line on the canvas
* @param canvas: pointer to a canvas object
* @param points: point of the line
* @param point_cnt: number of points
* @param draw_dsc: pointer to an initialized `lv_draw_line_dsc_t` variable
* @param canvas pointer to a canvas object
* @param points point of the line
* @param point_cnt number of points
* @param draw_dsc pointer to an initialized `lv_draw_line_dsc_t` variable
*/
void lv_canvas_draw_line(lv_obj_t * canvas, const lv_point_t points[], uint32_t point_cnt,
const lv_draw_line_dsc_t * draw_dsc);
/**
* Draw a polygon on the canvas
* @param canvas: pointer to a canvas object
* @param points: point of the polygon
* @param point_cnt: number of points
* @param draw_dsc: pointer to an initialized `lv_draw_rect_dsc_t` variable
* @param canvas pointer to a canvas object
* @param points point of the polygon
* @param point_cnt number of points
* @param draw_dsc pointer to an initialized `lv_draw_rect_dsc_t` variable
*/
void lv_canvas_draw_polygon(lv_obj_t * canvas, const lv_point_t points[], uint32_t point_cnt,
const lv_draw_rect_dsc_t * draw_dsc);
/**
* Draw an arc on the canvas
* @param canvas: pointer to a canvas object
* @param x: origo x of the arc
* @param y: origo y of the arc
* @param r: radius of the arc
* @param start_angle: start angle in degrees
* @param end_angle: end angle in degrees
* @param draw_dsc: pointer to an initialized `lv_draw_line_dsc_t` variable
* @param canvas pointer to a canvas object
* @param x origo x of the arc
* @param y origo y of the arc
* @param r radius of the arc
* @param start_angle start angle in degrees
* @param end_angle end angle in degrees
* @param draw_dsc pointer to an initialized `lv_draw_line_dsc_t` variable
*/
void lv_canvas_draw_arc(lv_obj_t * canvas, lv_coord_t x, lv_coord_t y, lv_coord_t r, int32_t start_angle,
int32_t end_angle, const lv_draw_arc_dsc_t * draw_dsc);

2
src/lv_widgets/lv_textarea.c
View File

@ -1171,7 +1171,7 @@ static void pwd_char_hider_anim_ready(lv_anim_t * a)
/**
* Hide all characters (convert them to '*')
* @param ta: pointer to text area object
* @param ta pointer to text area object
*/
static void pwd_char_hider(lv_obj_t * obj)
{

2
src/lv_widgets/lv_textarea.h
View File

@ -144,7 +144,7 @@ void lv_textarea_set_cursor_pos(lv_obj_t * ta, int32_t pos);
/**
* Hide/Unhide the cursor.
* @param ta pointer to a text area object
* @param hide: true: hide the cursor
* @param hide true: hide the cursor
*/
void lv_textarea_set_cursor_hidden(lv_obj_t * ta, bool hide);