[awtk]: fix api doc error

project/gui/awtk/src/base/assets_manager.h

@@ -221,7 +221,7 @@ ret_t assets_manager_add_data(assets_manager_t* am, const char* name, uint16_t t
  * @param {asset_type_t} type 资源的类型。
  * @param {char*} name 资源的名称。
  *
- * @return {asset_info_t*} 返回资源。
+ * @return {const asset_info_t*} 返回资源。
  */
 const asset_info_t* assets_manager_ref(assets_manager_t* am, asset_type_t type, const char* name);
 
@@ -234,7 +234,7 @@ const asset_info_t* assets_manager_ref(assets_manager_t* am, asset_type_t type,
  * @param {uint16_t} subtype 资源的子类型。
  * @param {char*} name 资源的名称。
  *
- * @return {asset_info_t*} 返回资源。
+ * @return {const asset_info_t*} 返回资源。
  */
 const asset_info_t* assets_manager_ref_ex(assets_manager_t* am, asset_type_t type, uint16_t subtype,
                                           const char* name);
@@ -258,7 +258,7 @@ ret_t assets_manager_unref(assets_manager_t* am, const asset_info_t* info);
  * @param {uint16_t} subtype 资源的子类型。
  * @param {char*} name 资源的名称。
  *
- * @return {asset_info_t*} 返回资源。
+ * @return {const asset_info_t*} 返回资源。
  */
 const asset_info_t* assets_manager_find_in_cache(assets_manager_t* am, asset_type_t type,
                                                  uint16_t subtype, const char* name);

project/gui/awtk/src/base/bidi.h

@@ -142,7 +142,7 @@ bidi_t* bidi_init(bidi_t* bidi, bool_t alloc_l2v, bool_t alloc_v2l, bidi_type_t
  * @annotation ["static"]
  * @param {const char*} name 类型名称(取值：rtl,ltr,auto,wrtl,wltr,lro,rlo)。 
  *
- * @return {bidi_t*} 返回bidi对象。
+ * @return {bidi_type_t} 返回bidi对象。
  */
 bidi_type_t bidi_type_from_name(const char* name);
 

project/gui/awtk/src/base/canvas_offline.h

@@ -213,7 +213,7 @@ bitmap_t* canvas_offline_custom_get_bitmap(canvas_t* canvas);
  *
  * @param {canvas_t*} canvas 离线 canvas 对象。
  *
- * @return {bitmap_t*} 返回 bitmap_t 对象表示成功，返回 NULL 表示失败。
+ * @return {ret_t} 返回RET_OK表示成功，否则表示失败。
  */
 ret_t canvas_offline_custom_bitmap_move_to_new_bitmap(canvas_t* canvas, bitmap_t* bitmap);
 

project/gui/awtk/src/base/children_layouter.h

@@ -71,7 +71,7 @@ struct _children_layouter_t {
  * 获取全部参数。
  * @param {children_layouter_t*} layouter layouter对象。
  *
- * @return {ret_t} 返回字符串格式的参数。
+ * @return {const char*} 返回字符串格式的参数。
  */
 const char* children_layouter_to_string(children_layouter_t* layouter);
 
@@ -132,7 +132,7 @@ ret_t children_layouter_set_param_str(children_layouter_t* layouter, const char*
  * @param {const char*} name 参数名。
  * @param {float_t} defval 缺省值。
  *
- * @return {ret_t} 成功返回参数的值，失败返回缺省值。
+ * @return {float_t} 成功返回参数的值，失败返回缺省值。
  */
 float_t children_layouter_get_param_float(children_layouter_t* layouter, const char* name,
                                           float_t defval);
@@ -145,7 +145,7 @@ float_t children_layouter_get_param_float(children_layouter_t* layouter, const c
  * @param {const char*} name 参数名。
  * @param {int32_t} defval 缺省值。
  *
- * @return {ret_t} 成功返回参数的值，失败返回缺省值。
+ * @return {int32_t} 成功返回参数的值，失败返回缺省值。
  */
 int32_t children_layouter_get_param_int(children_layouter_t* layouter, const char* name,
                                         int32_t defval);

project/gui/awtk/src/base/clip_board.h

@@ -78,7 +78,7 @@ struct _clip_board_t {
  * @alias clip_board_instance
  * @annotation ["constructor"]
  *
- * @return {ret_t} 返回缺省剪切板对象。
+ * @return {clip_board_t*} 返回缺省剪切板对象。
  */
 clip_board_t* clip_board(void);
 

project/gui/awtk/src/base/font.h

@@ -195,7 +195,7 @@ font_vmetrics_t font_get_vmetrics(font_t* font, font_size_t font_size);
  * @param {const char*} font_name 字体名称。
  * @param {font_size_t} font_size 字体大小。
  *
- * @return {int32_t} 返回TRUE表示成功，FALSE表示失败。
+ * @return {bool_t} 返回TRUE表示成功，FALSE表示失败。
  */
 bool_t font_match(font_t* font, const char* font_name, font_size_t font_size);
 

project/gui/awtk/src/base/g2d.h

@@ -73,7 +73,7 @@ ret_t g2d_copy_image(bitmap_t* fb, bitmap_t* img, const rect_t* src, xy_t dx, xy
 ret_t g2d_rotate_image(bitmap_t* fb, bitmap_t* img, const rect_t* src, lcd_orientation_t o);
 
 /**
- * @method image_rotate_ex
+ * @method g2d_rotate_image_ex
  * @export none
  * 把图片指定的区域进行旋转。
  * @param {bitmap_t*} dst 目标图片对象。

project/gui/awtk/src/base/gradient.h

@@ -217,7 +217,7 @@ ret_t gradient_add_stop(gradient_t* gradient, color_t color, float stop);
  * @param {gradient_t*} gradient gradient对象。
  * @param {uint32_t} index 序数。
  *
- * @return {ret_t} 返回RET_OK表示成功，否则表示失败。
+ * @return {gradient_stop_t*} 返回index指定的关键点。
  */
 gradient_stop_t* gradient_get_stop(gradient_t* gradient, uint32_t index);
 

project/gui/awtk/src/base/idle.h

@@ -113,7 +113,7 @@ ret_t idle_remove_all_by_ctx(void* ctx);
  * @method idle_find
  * 查找指定ID的idle。
  *
- * @return {idle_info_t*} 返回idle的信息。
+ * @return {const idle_info_t*} 返回idle的信息。
  */
 const idle_info_t* idle_find(uint32_t idle_id);
 

project/gui/awtk/src/base/input_engine.h

@@ -203,7 +203,7 @@ ret_t input_engine_add_candidates_from_string(input_engine_t* engine, const tabl
 ret_t input_engine_dispatch_candidates(input_engine_t* engine, int32_t selected);
 
 /**
- * @engine input_engine_set_lang
+ * @@method input_engine_set_lang
  * 设置语言。
  * > 有时在同一种语言环境下，也需要输入多种文字，典型的情况是同时输入中文和英文。
  * > 比如T9输入法，可以同时支持中文和英文输入，配合软键盘随时切换输入的语言。
@@ -219,7 +219,7 @@ ret_t input_engine_dispatch_candidates(input_engine_t* engine, int32_t selected)
 ret_t input_engine_set_lang(input_engine_t* engine, const char* lang);
 
 /**
- * @engine input_engine_get_lang
+ * @method input_engine_get_lang
  * 获取语言。
  * @annotation ["scriptable"]
  * @param {input_engine_t*} engine 输入法引擎对象。

project/gui/awtk/src/base/native_window.h

@@ -242,7 +242,7 @@ ret_t native_window_set_title(native_window_t* win, const char* app_name);
  *
  * @param {native_window_t*} win win对象。
  *
- * @return {canvas_t} 返回canvas对象。
+ * @return {canvas_t*} 返回canvas对象。
  */
 canvas_t* native_window_get_canvas(native_window_t* win);
 

project/gui/awtk/src/base/self_layouter.h

@@ -69,7 +69,7 @@ struct _self_layouter_t {
  * 获取全部参数。
  * @param {self_layouter_t*} layouter layouter对象。
  *
- * @return {ret_t} 返回字符串格式的参数。
+ * @return {const char*} 返回字符串格式的参数。
  */
 const char* self_layouter_to_string(self_layouter_t* layouter);
 
@@ -124,7 +124,7 @@ ret_t self_layouter_set_param_str(self_layouter_t* layouter, const char* name, c
  * @param {const char*} name 参数名。
  * @param {float_t} defval 缺省值。
  *
- * @return {ret_t} 成功返回参数的值，失败返回缺省值。
+ * @return {float_t} 成功返回参数的值，失败返回缺省值。
  */
 float_t self_layouter_get_param_float(self_layouter_t* layouter, const char* name, float_t defval);
 
@@ -135,7 +135,7 @@ float_t self_layouter_get_param_float(self_layouter_t* layouter, const char* nam
  * @param {const char*} name 参数名。
  * @param {int32_t} defval 缺省值。
  *
- * @return {ret_t} 成功返回参数的值，失败返回缺省值。
+ * @return {int32_t} 成功返回参数的值，失败返回缺省值。
  */
 int32_t self_layouter_get_param_int(self_layouter_t* layouter, const char* name, int32_t defval);
 

project/gui/awtk/src/base/text_edit.h

@@ -86,7 +86,7 @@ typedef struct _text_edit_t {
  * @param {widget_t*} widget 控件
  * @param {bool_t} single_line 是否是单行编辑器。
  *
- * @return {widget_t*} 对象。
+ * @return {text_edit_t*} 对象。
  */
 text_edit_t* text_edit_create(widget_t* widget, bool_t single_line);
 

project/gui/awtk/src/base/timer.h

@@ -177,7 +177,7 @@ ret_t timer_set_on_destroy(uint32_t timer_id, tk_destroy_t on_destroy, void* on_
  * @method timer_find
  * 查找指定ID的timer。
  *
- * @return {timer_info_t*} 返回timer的信息。
+ * @return {const timer_info_t*} 返回timer的信息。
  */
 const timer_info_t* timer_find(uint32_t timer_id);
 

project/gui/awtk/src/base/widget_animator_manager.h

@@ -123,7 +123,7 @@ ret_t widget_animator_manager_remove(widget_animator_manager_t* am, widget_anima
  * 获取动画个数。
  * @param {widget_animator_manager_t*} am 控件动画管理器。
  *
- * @return {ret_t} 返回动画个数。
+ * @return {uint32_t} 返回动画个数。
  */
 uint32_t widget_animator_manager_count(widget_animator_manager_t* am);
 

project/gui/awtk/src/conf_io/conf_node.h

@@ -108,7 +108,7 @@ ret_t conf_doc_append_sibling(conf_doc_t* doc, conf_node_t* node, conf_node_t* s
  * @param {conf_node_t*} node 节点对象。
  * @param {const char*} new_name 节点名称。
  *
- * @return {ret_t} 返回新节点。
+ * @return {conf_node_t*} 返回新节点。
  */
 conf_node_t* conf_doc_dup_node(conf_doc_t* doc, conf_node_t* node, const char* new_name);
 
@@ -137,7 +137,7 @@ ret_t conf_doc_set_node_prop(conf_doc_t* doc, conf_node_t* node, const char* nam
  * @param {const char*} path 路径。
  * @param {bool_t} create_if_not_exist 不存在是否创建。
  *
- * @return {ret_t} 返回RET_OK表示成功，否则表示失败。
+ * @return {conf_node_t*} 返回RET_OK表示成功，否则表示失败。
  */
 conf_node_t* conf_doc_find_node(conf_doc_t* doc, conf_node_t* node, const char* path,
                                 bool_t create_if_not_exist);

project/gui/awtk/src/csv/csv_file.h

@@ -117,7 +117,7 @@ csv_file_t* csv_file_create(const char* filename, char sep);
  * @param {uint32_t} size 数据长度。
  * @param {char} sep 分隔符。
  * 
- * @return {csv_file_t} 返回csv对象。
+ * @return {csv_file_t*} 返回csv对象。
  */
 csv_file_t* csv_file_create_with_buff(const char* buff, uint32_t size, char sep);
 

project/gui/awtk/src/debugger/debugger_fscript.h

@@ -91,7 +91,7 @@ debugger_t* debugger_fscript_create(void);
  * @param {debugger_t*} debugger debugger对象。
  * @param {fscript_t*} fscript 脚本对象。
  *
- * @return {debugger_t*} 返回debugger对象。
+ * @return {ret_t} 返回RET_OK表示成功，否则表示失败。
  */
 ret_t debugger_fscript_set_fscript(debugger_t* debugger, fscript_t* fscript);
 
@@ -111,7 +111,7 @@ debugger_fscript_t* debugger_fscript_cast(debugger_t* debugger);
  * @param {const binary_data_t*} code 代码。
  * @param {bool_t} changed 是否重新加载。
  *
- * @return {debugger_t*} 返回debugger对象。
+ * @return {ret_t} 返回RET_OK表示成功，否则表示失败。
  */
 ret_t debugger_fscript_set_code(debugger_t* debugger, const binary_data_t* code, bool_t changed);
 

project/gui/awtk/src/ext_widgets/mutable_image/mutable_image.h

@@ -200,7 +200,7 @@ widget_t* mutable_image_init(widget_t* widget);
  * @annotation ["cast"]
  * @param {widget_t*} widget mutable_image对象。
  *
- * @return {widget_t*} 返回RET_OK表示成功，否则表示失败。
+ * @return {ret_t} 返回RET_OK表示成功，否则表示失败。
  */
 ret_t mutable_image_on_destroy(widget_t* widget);
 
@@ -212,7 +212,7 @@ ret_t mutable_image_on_destroy(widget_t* widget);
  * @param {widget_t*} widget mutable_image对象。
  * @param {canvas_t*} canvas 画布对象。
  *
- * @return {widget_t*} 返回RET_OK表示成功，否则表示失败。
+ * @return {ret_t} 返回RET_OK表示成功，否则表示失败。
  */
 ret_t mutable_image_on_paint_self(widget_t* widget, canvas_t* canvas);
 

project/gui/awtk/src/fscript_ext/fscript_array.h

@@ -65,7 +65,7 @@ ret_t fscript_array_register(void);
  * @method fscript_array_get_fscript_array_vt
  * 获取 fscript array 的虚表。
  *
- * @return {ret_t} 成功返回虚表指针，失败返回 NULL。
+ * @return {const fscript_array_vtable_t*} 成功返回虚表指针，失败返回 NULL。
  */
 const fscript_array_vtable_t* fscript_array_get_fscript_array_vt(tk_object_t* obj);
 

project/gui/awtk/src/hal/network_interface.h

@@ -152,7 +152,7 @@ struct _network_interface_t {
  * @param {char *} interface 网卡名。
  * @param {network_interface_type_t} type 网卡接口类型。
  *
- * @return {network_interface_t} 网卡接口对象。
+ * @return {network_interface_t*} 网卡接口对象。
  */
 network_interface_t* network_interface_create(const char* interface, network_interface_type_t type);
 

project/gui/awtk/src/lcd/lcd_mem.h

@@ -55,7 +55,7 @@ typedef struct _lcd_mem_t {
 #define lcd_mem_set_line_length(lcd, value) lcd_set_line_length(lcd, value);
 
 /**
- * @method lcd_resize
+ * @method lcd_mem_set_wait_vbi
  * 设置等待VBI事件到来的回调函数。
  * > VBI: vertical blank interrupt。用于2fb等待当前显示完成，以便把下一帧的数据从offline fb拷贝到online fb，从而避免因为同时访问online fb数据造成闪烁。
  * @export none

project/gui/awtk/src/tkc/asset_info.h

@@ -422,7 +422,7 @@ const char* asset_info_get_name(const asset_info_t* info);
  *
  * @param {const char*} name 未格式化名字。
  *
- * @return {ret_t} 返回格式化后的名字。
+ * @return {const char*} 返回格式化后的名字。
  */
 const char* asset_info_get_formatted_name(const char* name);
 
@@ -447,7 +447,7 @@ bool_t asset_info_is_in_rom(const asset_info_t* info);
  * @param {asset_info_t*} info asset_info对象。
  *  @param {bool_t} is_in_rom 资源是否在ROM中。
  *
- * @return {bool_t} 返回 TRUE 为在 ROM 中，返回 FALSE 则不在。
+ * @return {ret_t} 返回RET_OK表示成功，否则表示失败。
  */
 ret_t asset_info_set_is_in_rom(asset_info_t* info, bool_t is_in_rom);
 

project/gui/awtk/src/tkc/color.h

@@ -231,7 +231,7 @@ ret_t color_destroy(color_t* c);
  * @param {color_t*} c color对象。
  * @param {char*} str 内存。
  *
- * @return {char*} 获取16进制字符串表示的颜色。
+ * @return {const char*} 获取16进制字符串表示的颜色。
  */
 const char* color_hex_str(color_t c, char str[TK_COLOR_HEX_LEN + 1]);
 
@@ -241,7 +241,7 @@ const char* color_hex_str(color_t c, char str[TK_COLOR_HEX_LEN + 1]);
  * @param {color_t*} c color对象。
  * @param {char*} str 内存。
  *
- * @return {char*} 获取rgba格式表示的颜色。
+ * @return {const char*} 获取rgba格式表示的颜色。
  */
 const char* color_rgba_str(color_t c, char str[TK_COLOR_RGBA_LEN + 1]);
 

project/gui/awtk/src/tkc/color_parser.h

@@ -58,7 +58,7 @@ BEGIN_C_DECLS
  * @annotation ["static"]
  * @param {const char*} color 字符串格式的颜色。
  *
- * @return {void*} 返回color_t对象。
+ * @return {color_t} 返回color_t对象。
  */
 color_t color_parse(const char* color);
 

project/gui/awtk/src/tkc/emitter.h

@@ -214,7 +214,7 @@ ret_t emitter_set_on_destroy(emitter_t* emitter, uint32_t id, tk_destroy_t on_de
  * @param {emitter_t*} emitter emitter对象。
  * @param {uint32_t} id emitter_on返回的ID。
  *
- * @return {ret_t} 返回RET_OK表示成功，否则表示失败。
+ * @return {emitter_item_t*} 若存在,返回id对应的emitter_item_t，否则返回NULL。
  */
 emitter_item_t* emitter_find(emitter_t* emitter, uint32_t id);
 

project/gui/awtk/src/tkc/event_source_manager_default.h

@@ -42,7 +42,7 @@ BEGIN_C_DECLS
  *
  * @param {event_source_manager_t*} manager event_source_manager对象。
  *
- * @return {ret_t} 返回RET_OK表示成功，否则表示失败。
+ * @return {event_source_manager_t*} 返回事件源管理器对象。
  *
  */
 event_source_manager_t* event_source_manager_default_create(void);

project/gui/awtk/src/tkc/fs.h

@@ -427,7 +427,7 @@ struct _fs_t {
  * @param {const char*} name 文件名。
  * @param {const char*} mode 打开方式，取值请参考POSIX的[fopen函数](https://www.runoob.com/cprogramming/c-function-fopen.html)相应的参数。
  *
- * @return {ret_t} 返回非NULL表示成功，否则表示失败。
+ * @return {fs_file_t*} 返回非NULL表示成功，否则表示失败。
  */
 fs_file_t* fs_open_file(fs_t* fs, const char* name, const char* mode);
 
@@ -516,7 +516,7 @@ ret_t fs_copy_dir_ex(fs_t* fs, const char* src, const char* dst, bool_t overwrit
  * @param {fs_t*} fs 文件系统对象，一般赋值为os_fs()。
  * @param {const char*} name 目录名称。
  *
- * @return {fs_dir_t} 返回非NULL表示成功，否则表示失败。
+ * @return {fs_dir_t*} 返回非NULL表示成功，否则表示失败。
  */
 fs_dir_t* fs_open_dir(fs_t* fs, const char* name);
 
@@ -625,7 +625,7 @@ ret_t fs_dir_rename(fs_t* fs, const char* name, const char* new_name);
  * @param {fs_t*} fs 文件系统对象，一般赋值为os_fs()。
  * @param {const char*} name 文件名。
  *
- * @return {ret_t} 返回不是-1表示成功，否则表示失败。
+ * @return {int32_t} 返回不是-1表示成功，否则表示失败。
  */
 int32_t fs_get_file_size(fs_t* fs, const char* name);
 
@@ -751,7 +751,7 @@ fs_t* os_fs(void);
  * @param {tk_visit_t} on_file 回调函数(完整文件名通过data参数传入)。
  * @param {void*} ctx 回调函数上下文。
  *
- * @return {bool_t} 返回TRUE表示成功，否则表示失败。
+ * @return {ret_t} 返回TRUE表示成功，否则表示失败。
  */
 ret_t fs_foreach_file(const char* path, tk_visit_t on_file, void* ctx);
 

project/gui/awtk/src/tkc/idle_manager.h

@@ -154,7 +154,7 @@ ret_t idle_manager_append(idle_manager_t* idle_manager, idle_info_t* idle);
  * @param {idle_manager_t*} idle_manager idle_manager_t管理器对象。
  * @param {uint32_t} idle_id idle_id。
  *
- * @return {idle_info_t*} 返回idle的信息。
+ * @return {const idle_info_t*} 返回idle的信息。
  */
 const idle_info_t* idle_manager_find(idle_manager_t* idle_manager, uint32_t idle_id);