github-code/lvgl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs more spelling fixes (#2499)

Browse Source
This commit is contained in:
ckielstra
2021-08-27 12:15:39 +02:00
committed by GitHub
parent 9f6d911b37
commit 5249a34d5d
60 changed files with 167 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/widgets/lv_arc.c
View File

@@ -58,7 +58,7 @@ const lv_obj_class_t lv_arc_class = {
**********************/
/**
* Create a arc object
* Create an arc object
* @param par pointer to an object, it will be the parent of the new arc
* @return pointer to the created arc
*/
@@ -244,7 +244,7 @@ void lv_arc_set_mode(lv_obj_t * obj, lv_arc_mode_t type)
/**
* Set a new value on the arc
* @param arc pointer to a arc object
* @param arc pointer to an arc object
* @param value new value
*/
void lv_arc_set_value(lv_obj_t * obj, int16_t value)
@@ -265,7 +265,7 @@ void lv_arc_set_value(lv_obj_t * obj, int16_t value)
}
/**
* Set minimum and the maximum values of a arc
* Set minimum and the maximum values of an arc
* @param arc pointer to the arc object
* @param min minimum value
* @param max maximum value
@@ -293,7 +293,7 @@ void lv_arc_set_range(lv_obj_t * obj, int16_t min, int16_t max)
/**
* Set the threshold of arc knob increments
* position.
* @param arc pointer to a arc object
* @param arc pointer to an arc object
* @param threshold increment threshold
*/
void lv_arc_set_change_rate(lv_obj_t * obj, uint16_t rate)
@@ -354,8 +354,8 @@ uint16_t lv_arc_get_bg_angle_end(lv_obj_t * obj)
/**
* Get the value of a arc
* @param arc pointer to a arc object
* Get the value of an arc
* @param arc pointer to an arc object
* @return the value of the arc
*/
int16_t lv_arc_get_value(const lv_obj_t * obj)
@@ -365,8 +365,8 @@ int16_t lv_arc_get_value(const lv_obj_t * obj)
}
/**
* Get the minimum value of a arc
* @param arc pointer to a arc object
* Get the minimum value of an arc
* @param arc pointer to an arc object
* @return the minimum value of the arc
*/
int16_t lv_arc_get_min_value(const lv_obj_t * obj)
@@ -376,8 +376,8 @@ int16_t lv_arc_get_min_value(const lv_obj_t * obj)
}
/**
* Get the maximum value of a arc
* @param arc pointer to a arc object
* Get the maximum value of an arc
* @param arc pointer to an arc object
* @return the maximum value of the arc
*/
int16_t lv_arc_get_max_value(const lv_obj_t * obj)
@@ -388,7 +388,7 @@ int16_t lv_arc_get_max_value(const lv_obj_t * obj)
/**
* Get whether the arc is type or not.
* @param arc pointer to a arc object
* @param arc pointer to an arc object
* @return arc type
*/
lv_arc_mode_t lv_arc_get_mode(const lv_obj_t * obj)
@@ -508,8 +508,8 @@ static void lv_arc_event(const lv_obj_class_t * class_p, lv_event_t * e)
int16_t delta_angle = angle - last_angle_rel;
/*Do not allow big jumps.
*It's mainly to avoid jumping to the opposite end if the "dead" range between min. an max. is crossed.
*Check which was closer on the last valid press (arc->min_close) and prefer that end*/
*It's mainly to avoid jumping to the opposite end if the "dead" range between min. and max. is crossed.
*Check which end was closer on the last valid press (arc->min_close) and prefer that end*/
if(LV_ABS(delta_angle) > 280) {
if(arc->min_close) angle = 0;
else angle = deg_range;
@@ -552,7 +552,7 @@ static void lv_arc_event(const lv_obj_class_t * class_p, lv_event_t * e)
}
}
/*Don1't let the elapsed time to big while sitting on an end point*/
/*Don't let the elapsed time become too big while sitting on an end point*/
if(new_value ==arc->min_value || new_value ==arc->max_value) {
arc->last_tick = lv_tick_get(); /*Cache timestamp for the next iteration*/
}
@@ -783,7 +783,7 @@ static void get_knob_area(lv_obj_t * obj, const lv_point_t * center, lv_coord_t
/**
* Used internally to update arc angles after a value change
* @param arc pointer to a arc object
* @param arc pointer to an arc object
*/
static void value_update(lv_obj_t * obj)
{

24
src/widgets/lv_arc.h
View File

@@ -69,7 +69,7 @@ typedef enum {
**********************/
/**
* Create a arc objects
* Create an arc object
* @param par pointer to an object, it will be the parent of the new arc
* @return pointer to the created arc
*/
@@ -143,13 +143,13 @@ void lv_arc_set_mode(lv_obj_t * arc, lv_arc_mode_t type);
/**
* Set a new value on the arc
* @param arc pointer to a arc object
* @param arc pointer to an arc object
* @param value new value
*/
void lv_arc_set_value(lv_obj_t * arc, int16_t value);
/**
* Set minimum and the maximum values of a arc
* Set minimum and the maximum values of an arc
* @param arc pointer to the arc object
* @param min minimum value
* @param max maximum value
@@ -157,8 +157,8 @@ void lv_arc_set_value(lv_obj_t * arc, int16_t value);
void lv_arc_set_range(lv_obj_t * arc, int16_t min, int16_t max);
/**
* Set a change rate to limit the speed how fast the arc should reache the pressed point.
* @param arc pointer to a arc object
* Set a change rate to limit the speed how fast the arc should reach the pressed point.
* @param arc pointer to an arc object
* @param rate the change rate
*/
void lv_arc_set_change_rate(lv_obj_t * arc, uint16_t rate);
@@ -196,29 +196,29 @@ uint16_t lv_arc_get_bg_angle_start(lv_obj_t * obj);
uint16_t lv_arc_get_bg_angle_end(lv_obj_t * obj);
/**
* Get the value of a arc
* @param arc pointer to a arc object
* Get the value of an arc
* @param arc pointer to an arc object
* @return the value of the arc
*/
int16_t lv_arc_get_value(const lv_obj_t * obj);
/**
* Get the minimum value of a arc
* @param arc pointer to a arc object
* Get the minimum value of an arc
* @param arc pointer to an arc object
* @return the minimum value of the arc
*/
int16_t lv_arc_get_min_value(const lv_obj_t * obj);
/**
* Get the maximum value of a arc
* @param arc pointer to a arc object
* Get the maximum value of an arc
* @param arc pointer to an arc object
* @return the maximum value of the arc
*/
int16_t lv_arc_get_max_value(const lv_obj_t * obj);
/**
* Get whether the arc is type or not.
* @param arc pointer to a arc object
* @param arc pointer to an arc object
* @return arc's mode
*/
lv_arc_mode_t lv_arc_get_mode(const lv_obj_t * obj);

6
src/widgets/lv_bar.c
View File

@@ -19,7 +19,7 @@
*********************/
#define MY_CLASS &lv_bar_class
/** hor. pad and ver. pad cannot make the indicator smaller then this [px]*/
/** hor. pad and ver. pad cannot make the indicator smaller than this [px]*/
#define LV_BAR_SIZE_MIN 4
#define LV_BAR_IS_ANIMATING(anim_struct) (((anim_struct).anim_state) != LV_BAR_ANIM_STATE_INV)
@@ -95,7 +95,7 @@ void lv_bar_set_value(lv_obj_t * obj, int32_t value, lv_anim_enable_t anim)
if(bar->cur_value == value) return;
value = LV_CLAMP(bar->min_value, value, bar->max_value);
value = value < bar->start_value ? bar->start_value : value; /*Can't be smaller then the left value*/
value = value < bar->start_value ? bar->start_value : value; /*Can't be smaller than the left value*/
if(bar->cur_value == value) return;
lv_bar_set_value_with_anim(obj, value, &bar->cur_value, &bar->cur_value_anim, anim);
@@ -108,7 +108,7 @@ void lv_bar_set_start_value(lv_obj_t * obj, int32_t value, lv_anim_enable_t anim
lv_bar_t * bar = (lv_bar_t *)obj;
value = LV_CLAMP(bar->min_value, value, bar->max_value);
value = value > bar->cur_value ? bar->cur_value : value; /*Can't be greater then the right value*/
value = value > bar->cur_value ? bar->cur_value : value; /*Can't be greater than the right value*/
if(bar->start_value == value) return;
lv_bar_set_value_with_anim(obj, value, &bar->start_value, &bar->start_value_anim, anim);

6
src/widgets/lv_btnmatrix.c
View File

@@ -361,7 +361,7 @@ static void lv_btnmatrix_constructor(const lv_obj_class_t * class_p, lv_obj_t *
lv_btnmatrix_set_map(obj, lv_btnmatrix_def_map);
LV_TRACE_OBJ_CREATE("finshed");
LV_TRACE_OBJ_CREATE("finished");
}
static void lv_btnmatrix_destructor(const lv_obj_class_t * class_p, lv_obj_t * obj)
@@ -373,7 +373,7 @@ static void lv_btnmatrix_destructor(const lv_obj_class_t * class_p, lv_obj_t * o
lv_mem_free(btnm->ctrl_bits);
btnm->button_areas = NULL;
btnm->ctrl_bits = NULL;
LV_TRACE_OBJ_CREATE("finshed");
LV_TRACE_OBJ_CREATE("finished");
}
static void lv_btnmatrix_event(const lv_obj_class_t * class_p, lv_event_t * e)
@@ -940,7 +940,7 @@ static void invalidate_button_area(const lv_obj_t * obj, uint16_t btn_idx)
lv_obj_get_coords(obj, &obj_area);
/*The buttons might have outline and shadow so make the invalidation larger with the gaps between the buttons.
*It assumes that the outline or shadow is smaller then the gaps*/
*It assumes that the outline or shadow is smaller than the gaps*/
lv_coord_t row_gap = lv_obj_get_style_pad_row(obj, LV_PART_MAIN);
lv_coord_t col_gap = lv_obj_get_style_pad_column(obj, LV_PART_MAIN);

4
src/widgets/lv_btnmatrix.h
View File

@@ -159,10 +159,10 @@ void lv_btnmatrix_set_btn_width(lv_obj_t * obj, uint16_t btn_id, uint8_t width);
/**
* Make the button matrix like a selector widget (only one button may be checked at a time).
* `LV_BTNMATRIX_CTRL_CHECKABLE` must be enabled on the buttons to be selected useing
* `LV_BTNMATRIX_CTRL_CHECKABLE` must be enabled on the buttons to be selected using
* `lv_btnmatrix_set_ctrl()` or `lv_btnmatrix_set_btn_ctrl_all()`.
* @param obj pointer to a button matrix object
* @param en: whether "one check" mode is enabled
* @param en whether "one check" mode is enabled
*/
void lv_btnmatrix_set_one_checked(lv_obj_t * obj, bool en);

2
src/widgets/lv_dropdown.h
View File

@@ -78,7 +78,7 @@ lv_obj_t * lv_dropdown_create(lv_obj_t * parent);
* If set to `NULL` the selected option's text will be displayed on the button.
* If set to a specific text then that text will be shown regardless the selected option.
* @param obj pointer to a drop-down list object
* @param txt the text as a string (Only it's pointer is saved)
* @param txt the text as a string (Only its pointer is saved)
*/
void lv_dropdown_set_text(lv_obj_t * obj, const char * txt);

2
src/widgets/lv_img.c
View File

@@ -489,7 +489,7 @@ static void lv_img_event(const lv_obj_class_t * class_p, lv_event_t * e)
angle += img->angle;
/*If the object is exactly image sized (not cropped, not mosaic) and transformed
*perform hit test on it's transformed area*/
*perform hit test on its transformed area*/
if(img->w == lv_obj_get_width(obj) && img->h == lv_obj_get_height(obj) &&
(zoom != LV_IMG_ZOOM_NONE || angle != 0 || img->pivot.x != img->w / 2 || img->pivot.y != img->h / 2)) {

2
src/widgets/lv_img.h
View File

@@ -138,7 +138,7 @@ void lv_img_set_zoom(lv_obj_t * obj, uint16_t zoom);
/**
* Enable/disable anti-aliasing for the transformations (rotate, zoom) or not.
* The qualitiy is better with anti-aliasing looks better but slower.
* The quality is better with anti-aliasing looks better but slower.
* @param obj pointer to an image object
* @param antialias true: anti-aliased; false: not anti-aliased
*/

10
src/widgets/lv_label.c
View File

@@ -481,7 +481,7 @@ uint32_t lv_label_get_letter_on(const lv_obj_t * obj, lv_point_t * pos_in)
/*Handle the recolor command*/
if((flag & LV_TEXT_FLAG_RECOLOR) != 0) {
if(_lv_txt_is_cmd(&cmd_state, bidi_txt[i]) != false) {
continue; /*Skip the letter is it is part of a command*/
continue; /*Skip the letter if it is part of a command*/
}
}
@@ -583,7 +583,7 @@ bool lv_label_is_char_under_pos(const lv_obj_t * obj, lv_point_t * pos)
/*Handle the recolor command*/
if((flag & LV_TEXT_FLAG_RECOLOR) != 0) {
if(_lv_txt_is_cmd(&cmd_state, txt[i]) != false) {
continue; /*Skip the letter is it is part of a command*/
continue; /*Skip the letter if it is part of a command*/
}
}
last_x = x;
@@ -856,7 +856,7 @@ static void draw_main(lv_event_t * e)
lv_txt_get_size(&size, label->text, label_draw_dsc.font, label_draw_dsc.letter_space, label_draw_dsc.line_space,
LV_COORD_MAX, flag);
/*Draw the text again on label to the original to make an circular effect */
/*Draw the text again on label to the original to make a circular effect */
if(size.x > lv_area_get_width(&txt_coords)) {
label_draw_dsc.ofs_x = label->offset.x + size.x +
lv_font_get_glyph_width(label_draw_dsc.font, ' ', ' ') * LV_LABEL_WAIT_CHAR_COUNT;
@@ -865,7 +865,7 @@ static void draw_main(lv_event_t * e)
lv_draw_label(&txt_coords, &txt_clip, &label_draw_dsc, label->text, hint);
}
/*Draw the text again below the original to make an circular effect */
/*Draw the text again below the original to make a circular effect */
if(size.y > lv_area_get_height(&txt_coords)) {
label_draw_dsc.ofs_x = label->offset.x;
label_draw_dsc.ofs_y = label->offset.y + size.y + lv_font_get_line_height(label_draw_dsc.font);
@@ -876,7 +876,7 @@ static void draw_main(lv_event_t * e)
}
/**
* Refresh the label with its text stored in its labelended data
* Refresh the label with its text stored in its extended data
* @param label pointer to a label object
*/
static void lv_label_refr_text(lv_obj_t * obj)

4
src/widgets/lv_label.h
View File

@@ -83,7 +83,7 @@ extern const lv_obj_class_t lv_label_class;
/**
* Create a label objects
* @param parent pointer to an object, it will be the parent of the new labely.
* @param parent pointer to an object, it will be the parent of the new label.
* @return pointer to the created button
*/
lv_obj_t * lv_label_create(lv_obj_t * parent);
@@ -109,7 +109,7 @@ void lv_label_set_text_fmt(lv_obj_t * obj, const char * fmt, ...) LV_FORMAT_ATTR
/**
* Set a static text. It will not be saved by the label so the 'text' variable
* has to be 'alive' while the label exist.
* has to be 'alive' while the label exists.
* @param label pointer to a label object
* @param text pointer to a text. NULL to refresh with the current text.
*/

2
src/widgets/lv_objx_templ.c
View File

@@ -5,7 +5,7 @@
/**
* TODO Remove these instructions
* Search an replace: templ -> object short name with lower case(e.g. btn, label etc)
* Search and replace: templ -> object short name with lower case(e.g. btn, label etc)
* TEMPL -> object short name with upper case (e.g. BTN, LABEL etc.)
*
* You can remove the defined() clause from the #if statement below. This exists because

2
src/widgets/lv_objx_templ.h
View File

@@ -5,7 +5,7 @@
/**
* TODO Remove these instructions
* Search an replace: templ -> object short name with lower case(e.g. btn, label etc)
* Search and replace: templ -> object short name with lower case(e.g. btn, label etc)
* TEMPL -> object short name with upper case (e.g. BTN, LABEL etc.)
*
*/