mirror of
https://github.com/lvgl/lvgl.git
synced 2024-11-27 11:43:43 +08:00
chore(doc) fix spelling in source comments and add missing parameter descriptions (#3607)
This commit is contained in:
parent
118a3bee76
commit
c069cf18fb
@ -130,7 +130,7 @@ Here are some simple examples of the callbacks:
|
||||
void my_flush_cb(lv_disp_drv_t * disp_drv, const lv_area_t * area, lv_color_t * color_p)
|
||||
{
|
||||
/*The most simple case (but also the slowest) to put all pixels to the screen one-by-one
|
||||
*`put_px` is just an example, it needs to implemented by you.*/
|
||||
*`put_px` is just an example, it needs to be implemented by you.*/
|
||||
int32_t x, y;
|
||||
for(y = area->y1; y <= area->y2; y++) {
|
||||
for(x = area->x1; x <= area->x2; x++) {
|
||||
|
@ -71,7 +71,7 @@ static int32_t kern_pair_16_compare(const void * ref, const void * element);
|
||||
**********************/
|
||||
|
||||
/**
|
||||
* Used as `get_glyph_bitmap` callback in LittelvGL's native font format if the font is uncompressed.
|
||||
* Used as `get_glyph_bitmap` callback in lvgl's native font format if the font is uncompressed.
|
||||
* @param font pointer to font
|
||||
* @param unicode_letter a unicode letter which bitmap should be get
|
||||
* @return pointer to the bitmap or NULL if not found
|
||||
@ -138,10 +138,11 @@ const uint8_t * lv_font_get_bitmap_fmt_txt(const lv_font_t * font, uint32_t unic
|
||||
}
|
||||
|
||||
/**
|
||||
* Used as `get_glyph_dsc` callback in LittelvGL's native font format if the font is uncompressed.
|
||||
* @param font_p pointer to font
|
||||
* Used as `get_glyph_dsc` callback in lvgl's native font format if the font is uncompressed.
|
||||
* @param font pointer to font
|
||||
* @param dsc_out store the result descriptor here
|
||||
* @param letter a UNICODE letter code
|
||||
* @param unicode_letter a UNICODE letter code
|
||||
* @param unicode_letter_next the unicode letter succeeding the letter under test
|
||||
* @return true: descriptor is successfully loaded into `dsc_out`.
|
||||
* false: the letter was not found, no data is loaded to `dsc_out`
|
||||
*/
|
||||
|
@ -202,7 +202,7 @@ typedef struct {
|
||||
**********************/
|
||||
|
||||
/**
|
||||
* Used as `get_glyph_bitmap` callback in LittelvGL's native font format if the font is uncompressed.
|
||||
* Used as `get_glyph_bitmap` callback in lvgl's native font format if the font is uncompressed.
|
||||
* @param font pointer to font
|
||||
* @param unicode_letter a unicode letter which bitmap should be get
|
||||
* @return pointer to the bitmap or NULL if not found
|
||||
@ -210,10 +210,11 @@ typedef struct {
|
||||
const uint8_t * lv_font_get_bitmap_fmt_txt(const lv_font_t * font, uint32_t letter);
|
||||
|
||||
/**
|
||||
* Used as `get_glyph_dsc` callback in LittelvGL's native font format if the font is uncompressed.
|
||||
* @param font_p pointer to font
|
||||
* Used as `get_glyph_dsc` callback in lvgl's native font format if the font is uncompressed.
|
||||
* @param font pointer to font
|
||||
* @param dsc_out store the result descriptor here
|
||||
* @param letter a UNICODE letter code
|
||||
* @param unicode_letter a UNICODE letter code
|
||||
* @param unicode_letter_next the unicode letter succeeding the letter under test
|
||||
* @return true: descriptor is successfully loaded into `dsc_out`.
|
||||
* false: the letter was not found, no data is loaded to `dsc_out`
|
||||
*/
|
||||
|
@ -68,7 +68,7 @@ static lv_disp_t * disp_def;
|
||||
|
||||
/**
|
||||
* Initialize a display driver with default values.
|
||||
* It is used to surly have known values in the fields ant not memory junk.
|
||||
* It is used to ensure all fields have known values and not memory junk.
|
||||
* After it you can set the fields.
|
||||
* @param driver pointer to driver variable to initialize
|
||||
*/
|
||||
|
@ -50,7 +50,7 @@
|
||||
|
||||
/**
|
||||
* Initialize an input device driver with default values.
|
||||
* It is used to surly have known values in the fields ant not memory junk.
|
||||
* It is used to ensure all fields have known values and not memory junk.
|
||||
* After it you can set the fields.
|
||||
* @param driver pointer to driver variable to initialize
|
||||
*/
|
||||
|
@ -326,7 +326,7 @@ bool _lv_area_is_equal(const lv_area_t * a, const lv_area_t * b)
|
||||
|
||||
/**
|
||||
* Align an area to an other
|
||||
* @param base an are where the other will be aligned
|
||||
* @param base an area where the other will be aligned
|
||||
* @param to_align the area to align
|
||||
* @param align `LV_ALIGN_...`
|
||||
* @param res x/y coordinates where `to_align` align area should be placed
|
||||
|
@ -230,7 +230,7 @@ bool _lv_area_is_equal(const lv_area_t * a, const lv_area_t * b);
|
||||
|
||||
/**
|
||||
* Align an area to an other
|
||||
* @param base an are where the other will be aligned
|
||||
* @param base an area where the other will be aligned
|
||||
* @param to_align the area to align
|
||||
* @param align `LV_ALIGN_...`
|
||||
*/
|
||||
|
@ -497,7 +497,7 @@ LV_ATTRIBUTE_FAST_MEM static inline void lv_color_premult(lv_color_t c, uint8_t
|
||||
}
|
||||
|
||||
/**
|
||||
* Mix two colors with a given ratio. It runs faster then `lv_color_mix` but requires some pre computation.
|
||||
* Mix two colors with a given ratio. It runs faster than `lv_color_mix` but requires some pre computation.
|
||||
* @param premult_c1 The first color. Should be preprocessed with `lv_color_premult(c1)`
|
||||
* @param c2 The second color. As it is no pre computation required on it
|
||||
* @param mix The ratio of the colors. 0: full `c1`, 255: full `c2`, 127: half `c1` and half `c2`.
|
||||
|
@ -117,7 +117,7 @@ void _lv_fs_init(void);
|
||||
|
||||
/**
|
||||
* Initialize a file system driver with default values.
|
||||
* It is used to surly have known values in the fields ant not memory junk.
|
||||
* It is used to ensure all fields have known values and not memory junk.
|
||||
* After it you can set the fields.
|
||||
* @param drv pointer to driver variable to initialize
|
||||
*/
|
||||
|
@ -146,7 +146,7 @@ LV_ATTRIBUTE_TIMER_HANDLER uint32_t lv_timer_handler(void)
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an "empty" timer. It needs to initialized with at least
|
||||
* Create an "empty" timer. It needs to be initialized with at least
|
||||
* `lv_timer_set_cb` and `lv_timer_set_period`
|
||||
* @return pointer to the created timer
|
||||
*/
|
||||
@ -185,7 +185,7 @@ lv_timer_t * lv_timer_create(lv_timer_cb_t timer_xcb, uint32_t period, void * us
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the callback the timer (the function to call periodically)
|
||||
* Set the callback to the timer (the function to call periodically)
|
||||
* @param timer pointer to a timer
|
||||
* @param timer_cb the function to call periodically
|
||||
*/
|
||||
|
@ -88,7 +88,7 @@ static inline LV_ATTRIBUTE_TIMER_HANDLER uint32_t lv_timer_handler_run_in_period
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an "empty" timer. It needs to initialized with at least
|
||||
* Create an "empty" timer. It needs to be initialized with at least
|
||||
* `lv_timer_set_cb` and `lv_timer_set_period`
|
||||
* @return pointer to the created timer
|
||||
*/
|
||||
@ -120,7 +120,7 @@ void lv_timer_pause(lv_timer_t * timer);
|
||||
void lv_timer_resume(lv_timer_t * timer);
|
||||
|
||||
/**
|
||||
* Set the callback the timer (the function to call periodically)
|
||||
* Set the callback to the timer (the function to call periodically)
|
||||
* @param timer pointer to a timer
|
||||
* @param timer_cb the function to call periodically
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user