aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVictor Wheeler <vwheeler63@users.noreply.github.com>2024-08-12 06:21:53 -0600
committerGitHub <noreply@github.com>2024-08-12 14:21:53 +0200
commit75bcfc6bec876e049e27ed1b0a97f8637baf171c (patch)
tree30d59ca0aff182373436eea72b5c5a892c99c64c
parent14461f1d9dcd168d59d07ea682ca671e55b1c0eb (diff)
downloadlvgl-75bcfc6bec876e049e27ed1b0a97f8637baf171c.tar.gz
lvgl-75bcfc6bec876e049e27ed1b0a97f8637baf171c.zip
fix(docbuild): Doxygen warnings from format errors (part 2 of 2) (#6653)
-rw-r--r--src/others/observer/lv_observer.h45
-rw-r--r--src/stdlib/lv_mem.h14
-rw-r--r--src/themes/lv_theme_private.h4
-rw-r--r--src/widgets/animimage/lv_animimage.h2
-rw-r--r--src/widgets/animimage/lv_animimage_private.h4
-rw-r--r--src/widgets/arc/lv_arc_private.h18
-rw-r--r--src/widgets/buttonmatrix/lv_buttonmatrix_private.h16
-rw-r--r--src/widgets/calendar/lv_calendar.h4
-rw-r--r--src/widgets/calendar/lv_calendar_private.h24
-rw-r--r--src/widgets/canvas/lv_canvas.h26
-rw-r--r--src/widgets/canvas/lv_canvas_private.h2
-rw-r--r--src/widgets/chart/lv_chart_private.h14
-rw-r--r--src/widgets/imagebutton/lv_imagebutton_private.h8
-rw-r--r--src/widgets/keyboard/lv_keyboard_private.h8
-rw-r--r--src/widgets/label/lv_label_private.h20
-rw-r--r--src/widgets/led/lv_led_private.h2
-rw-r--r--src/widgets/line/lv_line_private.h2
-rw-r--r--src/widgets/menu/lv_menu.h6
-rw-r--r--src/widgets/menu/lv_menu_private.h6
-rw-r--r--src/widgets/roller/lv_roller.h6
-rw-r--r--src/widgets/slider/lv_slider_private.h8
-rw-r--r--src/widgets/span/lv_span.h8
-rw-r--r--src/widgets/span/lv_span_private.h20
-rw-r--r--src/widgets/spinbox/lv_spinbox_private.h10
-rw-r--r--src/widgets/table/lv_table_private.h8
-rw-r--r--src/widgets/textarea/lv_textarea_private.h42
26 files changed, 166 insertions, 161 deletions
diff --git a/src/others/observer/lv_observer.h b/src/others/observer/lv_observer.h
index a3fc2a2d0..cec77feed 100644
--- a/src/others/observer/lv_observer.h
+++ b/src/others/observer/lv_observer.h
@@ -25,6 +25,9 @@ extern "C" {
* TYPEDEFS
**********************/
+/**
+ * Values for lv_submect_t's `type` field.
+ */
typedef enum {
LV_SUBJECT_TYPE_INVALID = 0, /**< indicates subject not initialized yet*/
LV_SUBJECT_TYPE_NONE = 1, /**< a null value like None or NILt*/
@@ -140,49 +143,49 @@ void lv_subject_init_pointer(lv_subject_t * subject, void * value);
/**
* Set the value of a pointer subject. It will notify all the observers as well.
* @param subject pointer to the subject
- * @param value the new value
+ * @param ptr new value
*/
void lv_subject_set_pointer(lv_subject_t * subject, void * ptr);
/**
* Get the current value of a pointer subject
* @param subject pointer to the subject
- * @return the current value
+ * @return current value
*/
const void * lv_subject_get_pointer(lv_subject_t * subject);
/**
* Get the previous value of a pointer subject
* @param subject pointer to the subject
- * @return the current value
+ * @return current value
*/
const void * lv_subject_get_previous_pointer(lv_subject_t * subject);
/**
* Initialize an color type subject
* @param subject pointer to the subject
- * @param value initial value
+ * @param color initial value
*/
void lv_subject_init_color(lv_subject_t * subject, lv_color_t color);
/**
* Set the value of a color subject. It will notify all the observers as well.
* @param subject pointer to the subject
- * @param value the new value
+ * @param color new value
*/
void lv_subject_set_color(lv_subject_t * subject, lv_color_t color);
/**
* Get the current value of a color subject
* @param subject pointer to the subject
- * @return the current value
+ * @return current value
*/
lv_color_t lv_subject_get_color(lv_subject_t * subject);
/**
* Get the previous value of a color subject
* @param subject pointer to the subject
- * @return the current value
+ * @return current value
*/
lv_color_t lv_subject_get_previous_color(lv_subject_t * subject);
@@ -213,7 +216,7 @@ lv_subject_t * lv_subject_get_group_element(lv_subject_t * subject, int32_t inde
/**
* Add an observer to a subject. When the subject changes `observer_cb` will be called.
* @param subject pointer to the subject
- * @param observer_cb the callback to call
+ * @param observer_cb callback to call
* @param user_data optional user data
* @return pointer to the created observer
*/
@@ -223,7 +226,7 @@ lv_observer_t * lv_subject_add_observer(lv_subject_t * subject, lv_observer_cb_t
* Add an observer to a subject for an object.
* When the object is deleted, it will be removed from the subject automatically.
* @param subject pointer to the subject
- * @param observer_cb the callback to call
+ * @param observer_cb callback to call
* @param obj pointer to an object
* @param user_data optional user data
* @return pointer to the created observer
@@ -234,13 +237,13 @@ lv_observer_t * lv_subject_add_observer_obj(lv_subject_t * subject, lv_observer_
/**
* Add an observer to a subject and also save a target.
* @param subject pointer to the subject
- * @param observer_cb the callback to call
+ * @param observer_cb callback to call
* @param target pointer to any data
* @param user_data optional user data
* @return pointer to the created observer
*/
-lv_observer_t * lv_subject_add_observer_with_target(lv_subject_t * subject, lv_observer_cb_t cb, void * target,
- void * user_data);
+lv_observer_t * lv_subject_add_observer_with_target(lv_subject_t * subject, lv_observer_cb_t observer_cb,
+ void * target, void * user_data);
/**
* Remove an observer from its subject
@@ -289,8 +292,8 @@ void lv_subject_notify(lv_subject_t * subject);
* Set an object flag if an integer subject's value is equal to a reference value, clear the flag otherwise
* @param obj pointer to an object
* @param subject pointer to a subject
- * @param flag a flag to set or clear (e.g. `LV_OBJ_FLAG_HIDDEN`)
- * @param ref_value a reference value to compare the subject's value with
+ * @param flag flag to set or clear (e.g. `LV_OBJ_FLAG_HIDDEN`)
+ * @param ref_value reference value to compare the subject's value with
* @return pointer to the created observer
*/
lv_observer_t * lv_obj_bind_flag_if_eq(lv_obj_t * obj, lv_subject_t * subject, lv_obj_flag_t flag, int32_t ref_value);
@@ -299,8 +302,8 @@ lv_observer_t * lv_obj_bind_flag_if_eq(lv_obj_t * obj, lv_subject_t * subject, l
* Set an object flag if an integer subject's value is not equal to a reference value, clear the flag otherwise
* @param obj pointer to an object
* @param subject pointer to a subject
- * @param flag a flag to set or clear (e.g. `LV_OBJ_FLAG_HIDDEN`)
- * @param ref_value a reference value to compare the subject's value with
+ * @param flag flag to set or clear (e.g. `LV_OBJ_FLAG_HIDDEN`)
+ * @param ref_value reference value to compare the subject's value with
* @return pointer to the created observer
*/
lv_observer_t * lv_obj_bind_flag_if_not_eq(lv_obj_t * obj, lv_subject_t * subject, lv_obj_flag_t flag,
@@ -310,8 +313,8 @@ lv_observer_t * lv_obj_bind_flag_if_not_eq(lv_obj_t * obj, lv_subject_t * subjec
* Set an object state if an integer subject's value is equal to a reference value, clear the flag otherwise
* @param obj pointer to an object
* @param subject pointer to a subject
- * @param flag a state to set or clear (e.g. `LV_STATE_CHECKED`)
- * @param ref_value a reference value to compare the subject's value with
+ * @param state state to set or clear (e.g. `LV_STATE_CHECKED`)
+ * @param ref_value reference value to compare the subject's value with
* @return pointer to the created observer
*/
lv_observer_t * lv_obj_bind_state_if_eq(lv_obj_t * obj, lv_subject_t * subject, lv_state_t state, int32_t ref_value);
@@ -320,8 +323,8 @@ lv_observer_t * lv_obj_bind_state_if_eq(lv_obj_t * obj, lv_subject_t * subject,
* Set an object state if an integer subject's value is not equal to a reference value, clear the flag otherwise
* @param obj pointer to an object
* @param subject pointer to a subject
- * @param flag a state to set or clear (e.g. `LV_STATE_CHECKED`)
- * @param ref_value a reference value to compare the subject's value with
+ * @param state state to set or clear (e.g. `LV_STATE_CHECKED`)
+ * @param ref_value reference value to compare the subject's value with
* @return pointer to the created observer
*/
lv_observer_t * lv_obj_bind_state_if_not_eq(lv_obj_t * obj, lv_subject_t * subject, lv_state_t state,
@@ -341,7 +344,7 @@ lv_observer_t * lv_obj_bind_checked(lv_obj_t * obj, lv_subject_t * subject);
* Bind an integer, string, or pointer subject to a label.
* @param obj pointer to a label
* @param subject pointer to a subject
- * @param fmt an optional format string with 1 format specifier (e.g. "%d °C")
+ * @param fmt optional format string with 1 format specifier (e.g. "%d °C")
* or NULL to bind the value directly.
* @return pointer to the created observer
* @note fmt == NULL can be used only with string and pointer subjects.
diff --git a/src/stdlib/lv_mem.h b/src/stdlib/lv_mem.h
index e0bfcaba0..210c18988 100644
--- a/src/stdlib/lv_mem.h
+++ b/src/stdlib/lv_mem.h
@@ -33,14 +33,14 @@ typedef void * lv_mem_pool_t;
* Heap information structure.
*/
typedef struct {
- size_t total_size; /**< Total heap size*/
+ size_t total_size; /**< Total heap size */
size_t free_cnt;
- size_t free_size; /**< Size of available memory*/
+ size_t free_size; /**< Size of available memory */
size_t free_biggest_size;
size_t used_cnt;
- size_t max_used; /**< Max size of Heap memory used*/
- uint8_t used_pct; /**< Percentage used*/
- uint8_t frag_pct; /**< Amount of fragmentation*/
+ size_t max_used; /**< Max size of Heap memory used */
+ uint8_t used_pct; /**< Percentage used */
+ uint8_t frag_pct; /**< Amount of fragmentation */
} lv_mem_monitor_t;
/**********************
@@ -110,8 +110,8 @@ void lv_free_core(void * p);
void * lv_realloc_core(void * p, size_t new_size);
/**
- * Used internally to execute a plain malloc operation
- * @param size size in bytes to malloc
+ * Used internally by lv_mem_monitor() to gather LVGL heap state information.
+ * @param mon_p pointer to lv_mem_monitor_t object to be populated.
*/
void lv_mem_monitor_core(lv_mem_monitor_t * mon_p);
diff --git a/src/themes/lv_theme_private.h b/src/themes/lv_theme_private.h
index d4b0cf1b0..6fd10a59c 100644
--- a/src/themes/lv_theme_private.h
+++ b/src/themes/lv_theme_private.h
@@ -26,7 +26,7 @@ extern "C" {
struct lv_theme_t {
lv_theme_apply_cb_t apply_cb;
- lv_theme_t * parent; /**< Apply the current theme's style on top of this theme.*/
+ lv_theme_t * parent; /**< Apply the current theme's style on top of this theme. */
void * user_data;
lv_display_t * disp;
lv_color_t color_primary;
@@ -34,7 +34,7 @@ struct lv_theme_t {
const lv_font_t * font_small;
const lv_font_t * font_normal;
const lv_font_t * font_large;
- uint32_t flags; /*Any custom flag used by the theme*/
+ uint32_t flags; /**< Any custom flag used by the theme */
};
diff --git a/src/widgets/animimage/lv_animimage.h b/src/widgets/animimage/lv_animimage.h
index d5d5b68fc..c7b3b0a8b 100644
--- a/src/widgets/animimage/lv_animimage.h
+++ b/src/widgets/animimage/lv_animimage.h
@@ -32,7 +32,7 @@ extern "C" {
LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_animimg_class;
-/*Image parts*/
+/** Image parts */
typedef enum {
LV_ANIM_IMAGE_PART_MAIN,
} lv_animimg_part_t;
diff --git a/src/widgets/animimage/lv_animimage_private.h b/src/widgets/animimage/lv_animimage_private.h
index 89d6f49ef..c4cf663d5 100644
--- a/src/widgets/animimage/lv_animimage_private.h
+++ b/src/widgets/animimage/lv_animimage_private.h
@@ -28,11 +28,11 @@ extern "C" {
* TYPEDEFS
**********************/
-/*Data of the animimage*/
+/** Data of the animimage */
struct lv_animimg_t {
lv_image_t img;
lv_anim_t anim;
- /*picture sequence */
+ /* picture sequence */
const void ** dsc;
int8_t pic_count;
};
diff --git a/src/widgets/arc/lv_arc_private.h b/src/widgets/arc/lv_arc_private.h
index 864651dc6..c784a6f6a 100644
--- a/src/widgets/arc/lv_arc_private.h
+++ b/src/widgets/arc/lv_arc_private.h
@@ -33,17 +33,17 @@ struct lv_arc_t {
lv_value_precise_t indic_angle_end;
lv_value_precise_t bg_angle_start;
lv_value_precise_t bg_angle_end;
- int32_t value; /*Current value of the arc*/
- int32_t min_value; /*Minimum value of the arc*/
- int32_t max_value; /*Maximum value of the arc*/
+ int32_t value; /**< Current value of the arc */
+ int32_t min_value; /**< Minimum value of the arc */
+ int32_t max_value; /**< Maximum value of the arc */
uint32_t dragging : 1;
uint32_t type : 2;
- uint32_t min_close : 1; /*1: the last pressed angle was closer to minimum end*/
- uint32_t in_out : 1; /* 1: The click was within the background arc angles. 0: Click outside */
- uint32_t chg_rate; /*Drag angle rate of change of the arc (degrees/sec)*/
- uint32_t last_tick; /*Last dragging event timestamp of the arc*/
- lv_value_precise_t last_angle; /*Last dragging angle of the arc*/
- int16_t knob_offset; /*knob offset from the main arc*/
+ uint32_t min_close : 1; /**< 1: the last pressed angle was closer to minimum end */
+ uint32_t in_out : 1; /**< 1: The click was within the background arc angles. 0: Click outside */
+ uint32_t chg_rate; /**< Drag angle rate of change of the arc (degrees/sec) */
+ uint32_t last_tick; /**< Last dragging event timestamp of the arc */
+ lv_value_precise_t last_angle; /**< Last dragging angle of the arc */
+ int16_t knob_offset; /**< knob offset from the main arc */
};
diff --git a/src/widgets/buttonmatrix/lv_buttonmatrix_private.h b/src/widgets/buttonmatrix/lv_buttonmatrix_private.h
index fdacdf3da..6893b0e1e 100644
--- a/src/widgets/buttonmatrix/lv_buttonmatrix_private.h
+++ b/src/widgets/buttonmatrix/lv_buttonmatrix_private.h
@@ -27,16 +27,16 @@ extern "C" {
* TYPEDEFS
**********************/
-/*Data of button matrix*/
+/** Data of button matrix */
struct lv_buttonmatrix_t {
lv_obj_t obj;
- const char ** map_p; /*Pointer to the current map*/
- lv_area_t * button_areas; /*Array of areas of buttons*/
- lv_buttonmatrix_ctrl_t * ctrl_bits; /*Array of control bytes*/
- uint32_t btn_cnt; /*Number of button in 'map_p'(Handled by the library)*/
- uint32_t row_cnt; /*Number of rows in 'map_p'(Handled by the library)*/
- uint32_t btn_id_sel; /*Index of the active button (being pressed/released etc) or LV_BUTTONMATRIX_BUTTON_NONE*/
- uint32_t one_check : 1; /*Single button toggled at once*/
+ const char ** map_p; /**< Pointer to the current map */
+ lv_area_t * button_areas; /**< Array of areas of buttons */
+ lv_buttonmatrix_ctrl_t * ctrl_bits; /**< Array of control bytes */
+ uint32_t btn_cnt; /**< Number of button in 'map_p'(Handled by the library) */
+ uint32_t row_cnt; /**< Number of rows in 'map_p'(Handled by the library) */
+ uint32_t btn_id_sel; /**< Index of the active button (being pressed/released etc) or LV_BUTTONMATRIX_BUTTON_NONE */
+ uint32_t one_check : 1; /**< Single button toggled at once */
};
diff --git a/src/widgets/calendar/lv_calendar.h b/src/widgets/calendar/lv_calendar.h
index 2dbf10245..38c5d644f 100644
--- a/src/widgets/calendar/lv_calendar.h
+++ b/src/widgets/calendar/lv_calendar.h
@@ -30,8 +30,8 @@ extern "C" {
*/
typedef struct {
uint16_t year;
- int8_t month; /** 1..12*/
- int8_t day; /** 1..31*/
+ int8_t month; /**< 1..12 */
+ int8_t day; /**< 1..31 */
} lv_calendar_date_t;
LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_calendar_class;
diff --git a/src/widgets/calendar/lv_calendar_private.h b/src/widgets/calendar/lv_calendar_private.h
index 9150a9411..d4a9b535b 100644
--- a/src/widgets/calendar/lv_calendar_private.h
+++ b/src/widgets/calendar/lv_calendar_private.h
@@ -27,27 +27,27 @@ extern "C" {
* TYPEDEFS
**********************/
-/*Data of calendar*/
+/** Data of calendar */
struct lv_calendar_t {
lv_obj_t obj;
- /*New data for this type*/
+ /* New data for this type */
lv_obj_t * btnm;
- lv_calendar_date_t today; /**< Date of today*/
- lv_calendar_date_t showed_date; /**< Currently visible month (day is ignored)*/
- lv_calendar_date_t * highlighted_dates; /**< Apply different style on these days (pointer to user-defined array)*/
- size_t highlighted_dates_num; /**< Number of elements in `highlighted_days`*/
+ lv_calendar_date_t today; /**< Date of today */
+ lv_calendar_date_t showed_date; /**< Currently visible month (day is ignored) */
+ lv_calendar_date_t * highlighted_dates; /**< Apply different style on these days (pointer to user-defined array) */
+ size_t highlighted_dates_num; /**< Number of elements in `highlighted_days` */
const char * map[8 * 7];
#ifdef LV_USE_CALENDAR_CHINESE
bool use_chinese_calendar;
- /* 7 * 6: A week has 7 days, and the calendar displays 6 weeks in total.
- 20: Including the number of dates, line breaks, names for each day,
- and reserving several spaces for addresses.*/
+ /** 7 * 6: A week has 7 days, and the calendar displays 6 weeks in total.
+ * 20: Including the number of dates, line breaks, names for each day,
+ * and reserving several spaces for addresses. */
char nums [7 * 6][20];
#else
- /* 7 * 6: A week has 7 days, and the calendar displays 6 weeks in total.
- 6: Including the number of dates, and reserving several spaces for
- addresses.*/
+ /** 7 * 6: A week has 7 days, and the calendar displays 6 weeks in total.
+ * 6: Including the number of dates, and reserving several spaces for
+ * addresses.*/
char nums [7 * 6][4];
#endif
};
diff --git a/src/widgets/canvas/lv_canvas.h b/src/widgets/canvas/lv_canvas.h
index 5123f164a..d669b1773 100644
--- a/src/widgets/canvas/lv_canvas.h
+++ b/src/widgets/canvas/lv_canvas.h
@@ -46,16 +46,18 @@ lv_obj_t * lv_canvas_create(lv_obj_t * parent);
/**
* Set a buffer for the canvas.
- * Use `lv_canvas_set_draw_buf` instead if you need to set a buffer with alignment requirement.
- * @param buf a buffer where the content of the canvas will be.
- * The required size is (lv_image_color_format_get_px_size(cf) * w) / 8 * h)
- * It can be allocated with `lv_malloc()` or
- * it can be statically allocated array (e.g. static lv_color_t buf[100*50]) or
- * it can be an address in RAM or external SRAM
- * @param canvas pointer to a canvas object
- * @param w width of the canvas
- * @param h height of the canvas
- * @param cf color format. `LV_COLOR_FORMAT...`
+ *
+ * Use lv_canvas_set_draw_buf() instead if you need to set a buffer with alignment requirement.
+ *
+ * @param obj pointer to a canvas object
+ * @param buf buffer where content of canvas will be.
+ * The required size is (lv_image_color_format_get_px_size(cf) * w) / 8 * h)
+ * It can be allocated with `lv_malloc()` or
+ * it can be statically allocated array (e.g. static lv_color_t buf[100*50]) or
+ * it can be an address in RAM or external SRAM
+ * @param w width of canvas
+ * @param h height of canvas
+ * @param cf color format. `LV_COLOR_FORMAT...`
*/
void lv_canvas_set_buffer(lv_obj_t * obj, void * buf, int32_t w, int32_t h, lv_color_format_t cf);
@@ -131,7 +133,7 @@ const void * lv_canvas_get_buf(lv_obj_t * canvas);
/**
* Copy a buffer to the canvas
- * @param canvas pointer to a canvas object
+ * @param obj pointer to a canvas object
* @param canvas_area the area of the canvas to copy
* @param dest_buf pointer to a buffer to store the copied data
* @param dest_area the area of the destination buffer to copy to. If omitted NULL, copy to the whole `dest_buf`
@@ -141,7 +143,7 @@ void lv_canvas_copy_buf(lv_obj_t * obj, const lv_area_t * canvas_area, lv_draw_b
/**
* Fill the canvas with color
- * @param canvas pointer to a canvas
+ * @param obj pointer to a canvas
* @param color the background color
* @param opa the desired opacity
*/
diff --git a/src/widgets/canvas/lv_canvas_private.h b/src/widgets/canvas/lv_canvas_private.h
index 13dc7ca74..e43b8f3f3 100644
--- a/src/widgets/canvas/lv_canvas_private.h
+++ b/src/widgets/canvas/lv_canvas_private.h
@@ -27,7 +27,7 @@ extern "C" {
* TYPEDEFS
**********************/
-/*Data of canvas*/
+/** Canvas data */
struct lv_canvas_t {
lv_image_t img;
lv_draw_buf_t * draw_buf;
diff --git a/src/widgets/chart/lv_chart_private.h b/src/widgets/chart/lv_chart_private.h
index 224050737..7cf9052aa 100644
--- a/src/widgets/chart/lv_chart_private.h
+++ b/src/widgets/chart/lv_chart_private.h
@@ -48,22 +48,22 @@ struct lv_chart_cursor_t {
lv_color_t color;
lv_chart_series_t * ser;
lv_dir_t dir;
- uint32_t pos_set: 1; /*1: pos is set; 0: point_id is set*/
+ uint32_t pos_set: 1; /**< 1: pos is set; 0: point_id is set*/
};
struct lv_chart_t {
lv_obj_t obj;
- lv_ll_t series_ll; /**< Linked list for the series (stores lv_chart_series_t)*/
- lv_ll_t cursor_ll; /**< Linked list for the cursors (stores lv_chart_cursor_t)*/
+ lv_ll_t series_ll; /**< Linked list for the series (stores lv_chart_series_t)*/
+ lv_ll_t cursor_ll; /**< Linked list for the cursors (stores lv_chart_cursor_t)*/
int32_t ymin[2];
int32_t ymax[2];
int32_t xmin[2];
int32_t xmax[2];
int32_t pressed_point_id;
- uint32_t hdiv_cnt; /**< Number of horizontal division lines*/
- uint32_t vdiv_cnt; /**< Number of vertical division lines*/
- uint32_t point_cnt; /**< Point number in a data line*/
- lv_chart_type_t type : 3; /**< Line or column chart*/
+ uint32_t hdiv_cnt; /**< Number of horizontal division lines*/
+ uint32_t vdiv_cnt; /**< Number of vertical division lines*/
+ uint32_t point_cnt; /**< Point number in a data line*/
+ lv_chart_type_t type : 3; /**< Line or column chart*/
lv_chart_update_mode_t update_mode : 1;
};
diff --git a/src/widgets/imagebutton/lv_imagebutton_private.h b/src/widgets/imagebutton/lv_imagebutton_private.h
index 8dc5d42b0..d061fd8e5 100644
--- a/src/widgets/imagebutton/lv_imagebutton_private.h
+++ b/src/widgets/imagebutton/lv_imagebutton_private.h
@@ -31,12 +31,12 @@ struct lv_imagebutton_src_info_t {
lv_image_header_t header;
};
-/*Data of image button*/
+/** Data of image button */
struct lv_imagebutton_t {
lv_obj_t obj;
- lv_imagebutton_src_info_t src_mid[LV_IMAGEBUTTON_STATE_NUM]; /*Store center images to each state*/
- lv_imagebutton_src_info_t src_left[LV_IMAGEBUTTON_STATE_NUM]; /*Store left side images to each state*/
- lv_imagebutton_src_info_t src_right[LV_IMAGEBUTTON_STATE_NUM]; /*Store right side images to each state*/
+ lv_imagebutton_src_info_t src_mid[LV_IMAGEBUTTON_STATE_NUM]; /**< Store center images to each state */
+ lv_imagebutton_src_info_t src_left[LV_IMAGEBUTTON_STATE_NUM]; /**< Store left side images to each state */
+ lv_imagebutton_src_info_t src_right[LV_IMAGEBUTTON_STATE_NUM]; /**< Store right side images to each state */
};
diff --git a/src/widgets/keyboard/lv_keyboard_private.h b/src/widgets/keyboard/lv_keyboard_private.h
index 8bb206ab2..757b23e9e 100644
--- a/src/widgets/keyboard/lv_keyboard_private.h
+++ b/src/widgets/keyboard/lv_keyboard_private.h
@@ -27,12 +27,12 @@ extern "C" {
* TYPEDEFS
**********************/
-/*Data of keyboard*/
+/** Data of keyboard */
struct lv_keyboard_t {
lv_buttonmatrix_t btnm;
- lv_obj_t * ta; /*Pointer to the assigned text area*/
- lv_keyboard_mode_t mode; /*Key map type*/
- uint8_t popovers : 1; /*Show button titles in popovers on press*/
+ lv_obj_t * ta; /**< Pointer to the assigned text area */
+ lv_keyboard_mode_t mode; /**< Key map type */
+ uint8_t popovers : 1; /**< Show button titles in popovers on press */
};
diff --git a/src/widgets/label/lv_label_private.h b/src/widgets/label/lv_label_private.h
index 84652a903..81a2e68ec 100644
--- a/src/widgets/label/lv_label_private.h
+++ b/src/widgets/label/lv_label_private.h
@@ -32,10 +32,10 @@ struct lv_label_t {
lv_obj_t obj;
char * text;
union {
- char * tmp_ptr; /*Pointer to the allocated memory containing the character replaced by dots*/
- char tmp[LV_LABEL_DOT_NUM + 1]; /*Directly store the characters if <=4 characters*/
+ char * tmp_ptr; /**< Pointer to the allocated memory containing the character replaced by dots */
+ char tmp[LV_LABEL_DOT_NUM + 1]; /**< Directly store the characters if <=4 characters */
} dot;
- uint32_t dot_end; /*The real text length, used in dot mode*/
+ uint32_t dot_end; /**< The real text length, used in dot mode */
#if LV_LABEL_LONG_TXT_HINT
lv_draw_label_hint_t hint;
@@ -46,13 +46,13 @@ struct lv_label_t {
uint32_t sel_end;
#endif
- lv_point_t size_cache; /*Text size cache*/
- lv_point_t offset; /*Text draw position offset*/
- lv_label_long_mode_t long_mode : 3; /*Determine what to do with the long texts*/
- uint8_t static_txt : 1; /*Flag to indicate the text is static*/
- uint8_t expand : 1; /*Ignore real width (used by the library with LV_LABEL_LONG_SCROLL)*/
- uint8_t dot_tmp_alloc : 1; /*1: dot is allocated, 0: dot directly holds up to 4 chars*/
- uint8_t invalid_size_cache : 1; /*1: Recalculate size and update cache*/
+ lv_point_t size_cache; /**< Text size cache */
+ lv_point_t offset; /**< Text draw position offset */
+ lv_label_long_mode_t long_mode : 3; /**< Determine what to do with the long texts */
+ uint8_t static_txt : 1; /**< Flag to indicate the text is static */
+ uint8_t expand : 1; /**< Ignore real width (used by the library with LV_LABEL_LONG_SCROLL) */
+ uint8_t dot_tmp_alloc : 1; /**< 1: dot is allocated, 0: dot directly holds up to 4 chars */
+ uint8_t invalid_size_cache : 1; /**< 1: Recalculate size and update cache */
};
diff --git a/src/widgets/led/lv_led_private.h b/src/widgets/led/lv_led_private.h
index 448069dde..ccd312b3c 100644
--- a/src/widgets/led/lv_led_private.h
+++ b/src/widgets/led/lv_led_private.h
@@ -26,7 +26,7 @@ extern "C" {
* TYPEDEFS
**********************/
-/*Data of led*/
+/** Data of led */
struct lv_led_t {
lv_obj_t obj;
lv_color_t color;
diff --git a/src/widgets/line/lv_line_private.h b/src/widgets/line/lv_line_private.h
index 900ea3a04..4cbce9c8e 100644
--- a/src/widgets/line/lv_line_private.h
+++ b/src/widgets/line/lv_line_private.h
@@ -27,7 +27,7 @@ extern "C" {
* TYPEDEFS
**********************/
-/*Data of line*/
+/** Data of line */
struct lv_line_t {
lv_obj_t obj;
union {
diff --git a/src/widgets/menu/lv_menu.h b/src/widgets/menu/lv_menu.h
index 4fe3766f7..3d75f8d9a 100644
--- a/src/widgets/menu/lv_menu.h
+++ b/src/widgets/menu/lv_menu.h
@@ -29,9 +29,9 @@ extern "C" {
* TYPEDEFS
**********************/
typedef enum {
- LV_MENU_HEADER_TOP_FIXED, /* Header is positioned at the top */
- LV_MENU_HEADER_TOP_UNFIXED, /* Header is positioned at the top and can be scrolled out of view*/
- LV_MENU_HEADER_BOTTOM_FIXED /* Header is positioned at the bottom */
+ LV_MENU_HEADER_TOP_FIXED, /**< Header is positioned at the top */
+ LV_MENU_HEADER_TOP_UNFIXED, /**< Header is positioned at the top and can be scrolled out of view*/
+ LV_MENU_HEADER_BOTTOM_FIXED /**< Header is positioned at the bottom */
} lv_menu_mode_header_t;
typedef enum {
diff --git a/src/widgets/menu/lv_menu_private.h b/src/widgets/menu/lv_menu_private.h
index 997fa862e..fca898df9 100644
--- a/src/widgets/menu/lv_menu_private.h
+++ b/src/widgets/menu/lv_menu_private.h
@@ -38,18 +38,18 @@ struct lv_menu_history_t {
struct lv_menu_t {
lv_obj_t obj;
- lv_obj_t * storage; /* a pointer to obj that is the parent of all pages not displayed */
+ lv_obj_t * storage; /**< a pointer to obj that is the parent of all pages not displayed */
lv_obj_t * main;
lv_obj_t * main_page;
lv_obj_t * main_header;
lv_obj_t *
- main_header_back_btn; /* a pointer to obj that on click triggers back btn event handler, can be same as 'main_header' */
+ main_header_back_btn; /**< a pointer to obj that on click triggers back btn event handler, can be same as 'main_header' */
lv_obj_t * main_header_title;
lv_obj_t * sidebar;
lv_obj_t * sidebar_page;
lv_obj_t * sidebar_header;
lv_obj_t *
- sidebar_header_back_btn; /* a pointer to obj that on click triggers back btn event handler, can be same as 'sidebar_header' */
+ sidebar_header_back_btn; /**< a pointer to obj that on click triggers back btn event handler, can be same as 'sidebar_header' */
lv_obj_t * sidebar_header_title;
lv_obj_t * selected_tab;
lv_ll_t history_ll;
diff --git a/src/widgets/roller/lv_roller.h b/src/widgets/roller/lv_roller.h
index f3306ca56..e6a94b299 100644
--- a/src/widgets/roller/lv_roller.h
+++ b/src/widgets/roller/lv_roller.h
@@ -32,10 +32,10 @@ extern "C" {
* TYPEDEFS
**********************/
-/** Roller mode.*/
+/** Roller mode. */
typedef enum {
- LV_ROLLER_MODE_NORMAL, /**< Normal mode (roller ends at the end of the options).*/
- LV_ROLLER_MODE_INFINITE, /**< Infinite mode (roller can be scrolled forever).*/
+ LV_ROLLER_MODE_NORMAL, /**< Normal mode (roller ends at the end of the options). */
+ LV_ROLLER_MODE_INFINITE, /**< Infinite mode (roller can be scrolled forever). */
} lv_roller_mode_t;
#if LV_USE_OBJ_PROPERTY
diff --git a/src/widgets/slider/lv_slider_private.h b/src/widgets/slider/lv_slider_private.h
index ad1d7e792..a1eab2f5b 100644
--- a/src/widgets/slider/lv_slider_private.h
+++ b/src/widgets/slider/lv_slider_private.h
@@ -28,13 +28,13 @@ extern "C" {
**********************/
struct lv_slider_t {
- lv_bar_t bar; /*Add the ancestor's type first*/
+ lv_bar_t bar; /**< Add the ancestor's type first */
lv_area_t left_knob_area;
lv_area_t right_knob_area;
lv_point_t pressed_point;
- int32_t * value_to_set; /*Which bar value to set*/
- uint8_t dragging : 1; /*1: the slider is being dragged*/
- uint8_t left_knob_focus : 1; /*1: with encoder now the right knob can be adjusted*/
+ int32_t * value_to_set; /**< Which bar value to set */
+ uint8_t dragging : 1; /**< 1: the slider is being dragged */
+ uint8_t left_knob_focus : 1; /**< 1: with encoder now the right knob can be adjusted */
};
diff --git a/src/widgets/span/lv_span.h b/src/widgets/span/lv_span.h
index 2eed5888b..f0406b918 100644
--- a/src/widgets/span/lv_span.h
+++ b/src/widgets/span/lv_span.h
@@ -35,10 +35,10 @@ typedef enum {
} lv_span_overflow_t;
typedef enum {
- LV_SPAN_MODE_FIXED, /**< fixed the obj size*/
- LV_SPAN_MODE_EXPAND, /**< Expand the object size to the text size*/
- LV_SPAN_MODE_BREAK, /**< Keep width, break the too long lines and expand height*/
- LV_SPAN_MODE_LAST /**< Fence member*/
+ LV_SPAN_MODE_FIXED, /**< fixed the obj size */
+ LV_SPAN_MODE_EXPAND, /**< Expand the object size to the text size */
+ LV_SPAN_MODE_BREAK, /**< Keep width, break the too long lines and expand height */
+ LV_SPAN_MODE_LAST /**< Fence member */
} lv_span_mode_t;
LV_ATTRIBUTE_EXTERN_DATA extern const lv_obj_class_t lv_spangroup_class;
diff --git a/src/widgets/span/lv_span_private.h b/src/widgets/span/lv_span_private.h
index 1fb031fe3..099ea1b7e 100644
--- a/src/widgets/span/lv_span_private.h
+++ b/src/widgets/span/lv_span_private.h
@@ -28,23 +28,23 @@ extern "C" {
**********************/
struct lv_span_t {
- char * txt; /* a pointer to display text */
- lv_obj_t * spangroup; /* a pointer to spangroup */
- lv_style_t style; /* display text style */
- uint32_t static_flag : 1;/* the text is static flag */
+ char * txt; /**< a pointer to display text */
+ lv_obj_t * spangroup; /**< a pointer to spangroup */
+ lv_style_t style; /**< display text style */
+ uint32_t static_flag : 1; /**< the text is static flag */
};
/** Data of label*/
struct lv_spangroup_t {
lv_obj_t obj;
int32_t lines;
- int32_t indent; /* first line indent */
- int32_t cache_w; /* the cache automatically calculates the width */
- int32_t cache_h; /* similar cache_w */
+ int32_t indent; /**< first line indent */
+ int32_t cache_w; /**< the cache automatically calculates the width */
+ int32_t cache_h; /**< similar cache_w */
lv_ll_t child_ll;
- uint32_t mode : 2; /* details see lv_span_mode_t */
- uint32_t overflow : 1; /* details see lv_span_overflow_t */
- uint32_t refresh : 1; /* the spangroup need refresh cache_w and cache_h */
+ uint32_t mode : 2; /**< details see lv_span_mode_t */
+ uint32_t overflow : 1; /**< details see lv_span_overflow_t */
+ uint32_t refresh : 1; /**< the spangroup need refresh cache_w and cache_h */
};
diff --git a/src/widgets/spinbox/lv_spinbox_private.h b/src/widgets/spinbox/lv_spinbox_private.h
index 50333a8cb..0569f2103 100644
--- a/src/widgets/spinbox/lv_spinbox_private.h
+++ b/src/widgets/spinbox/lv_spinbox_private.h
@@ -27,18 +27,18 @@ extern "C" {
* TYPEDEFS
**********************/
-/*Data of spinbox*/
+/** Data of spinbox */
struct lv_spinbox_t {
- lv_textarea_t ta; /*Ext. of ancestor*/
+ lv_textarea_t ta; /**< Ext. of ancestor */
/*New data for this type*/
int32_t value;
int32_t range_max;
int32_t range_min;
int32_t step;
uint32_t digit_count : 4;
- uint32_t dec_point_pos : 4; /*if 0, there is no separator and the number is an integer*/
- uint32_t rollover : 1; /* Set to true for rollover functionality*/
- uint32_t digit_step_dir : 2; /* the direction the digit will step on encoder button press when editing*/
+ uint32_t dec_point_pos : 4; /**< if 0, there is no separator and the number is an integer */
+ uint32_t rollover : 1; /**< Set to true for rollover functionality */
+ uint32_t digit_step_dir : 2; /**< the direction the digit will step on encoder button press when editing */
};
diff --git a/src/widgets/table/lv_table_private.h b/src/widgets/table/lv_table_private.h
index 410db7092..901fc30e0 100644
--- a/src/widgets/table/lv_table_private.h
+++ b/src/widgets/table/lv_table_private.h
@@ -26,14 +26,14 @@ extern "C" {
* TYPEDEFS
**********************/
-/*Data of cell*/
+/** Cell data */
struct lv_table_cell_t {
lv_table_cell_ctrl_t ctrl;
- void * user_data; /**< Custom user data*/
- char txt[1]; /**< Variable length array*/
+ void * user_data; /**< Custom user data */
+ char txt[1]; /**< Variable length array */
};
-/*Data of table*/
+/** Table data */
struct lv_table_t {
lv_obj_t obj;
uint32_t col_cnt;
diff --git a/src/widgets/textarea/lv_textarea_private.h b/src/widgets/textarea/lv_textarea_private.h
index e453de758..e2d3aaab9 100644
--- a/src/widgets/textarea/lv_textarea_private.h
+++ b/src/widgets/textarea/lv_textarea_private.h
@@ -27,34 +27,34 @@ extern "C" {
* TYPEDEFS
**********************/
-/*Data of text area*/
+/** Data of text area */
struct lv_textarea_t {
lv_obj_t obj;
- lv_obj_t * label; /*Label of the text area*/
- char * placeholder_txt; /*Place holder label. only visible if text is an empty string*/
- char * pwd_tmp; /*Used to store the original text in password mode*/
- char * pwd_bullet; /*Replacement characters displayed in password mode*/
- const char * accepted_chars; /*Only these characters will be accepted. NULL: accept all*/
- uint32_t max_length; /*The max. number of characters. 0: no limit*/
- uint32_t pwd_show_time; /*Time to show characters in password mode before change them to '*'*/
+ lv_obj_t * label; /**< Label of the text area */
+ char * placeholder_txt; /**< Place holder label. only visible if text is an empty string */
+ char * pwd_tmp; /**< Used to store the original text in password mode */
+ char * pwd_bullet; /**< Replacement characters displayed in password mode */
+ const char * accepted_chars; /**< Only these characters will be accepted. NULL: accept all */
+ uint32_t max_length; /**< The max. number of characters. 0: no limit */
+ uint32_t pwd_show_time; /**< Time to show characters in password mode before change them to '*' */
struct {
- int32_t valid_x; /*Used when stepping up/down to a shorter line.
- *(Used by the library)*/
- uint32_t pos; /*The current cursor position
- *(0: before 1st letter; 1: before 2nd letter ...)*/
- lv_area_t area; /*Cursor area relative to the Text Area*/
- uint32_t txt_byte_pos; /*Byte index of the letter after (on) the cursor*/
- uint8_t show : 1; /*Cursor is visible now or not (Handled by the library)*/
- uint8_t click_pos : 1; /*1: Enable positioning the cursor by clicking the text area*/
+ int32_t valid_x; /**< Used when stepping up/down to a shorter line.
+ *(Used by the library) */
+ uint32_t pos; /**< The current cursor position
+ *(0: before 1st letter; 1: before 2nd letter ...) */
+ lv_area_t area; /**< Cursor area relative to the Text Area */
+ uint32_t txt_byte_pos; /**< Byte index of the letter after (on) the cursor */
+ uint8_t show : 1; /**< Cursor is visible now or not (Handled by the library) */
+ uint8_t click_pos : 1; /**< 1: Enable positioning the cursor by clicking the text area */
} cursor;
#if LV_LABEL_TEXT_SELECTION
- uint32_t sel_start; /*Temporary values for text selection*/
+ uint32_t sel_start; /**< Temporary values for text selection */
uint32_t sel_end;
- uint8_t text_sel_in_prog : 1; /*User is in process of selecting*/
- uint8_t text_sel_en : 1; /*Text can be selected on this text area*/
+ uint8_t text_sel_in_prog : 1; /**< User is in process of selecting */
+ uint8_t text_sel_en : 1; /**< Text can be selected on this text area */
#endif
- uint8_t pwd_mode : 1; /*Replace characters with '*'*/
- uint8_t one_line : 1; /*One line mode (ignore line breaks)*/
+ uint8_t pwd_mode : 1; /**< Replace characters with '*' */
+ uint8_t one_line : 1; /**< One line mode (ignore line breaks) */
};