From b2d7e30f354ec6a2e83df1455a24fefd7acea384 Mon Sep 17 00:00:00 2001 From: lujiale Date: Fri, 17 Feb 2023 14:54:15 +0800 Subject: [PATCH] [awtk]: fix api doc error --- project/gui/awtk/src/base/assets_manager.h | 6 +++--- project/gui/awtk/src/base/bidi.h | 2 +- project/gui/awtk/src/base/canvas_offline.h | 2 +- project/gui/awtk/src/base/children_layouter.h | 6 +++--- project/gui/awtk/src/base/clip_board.h | 2 +- project/gui/awtk/src/base/font.h | 2 +- project/gui/awtk/src/base/g2d.h | 2 +- project/gui/awtk/src/base/gradient.h | 2 +- project/gui/awtk/src/base/idle.h | 2 +- project/gui/awtk/src/base/input_engine.h | 4 ++-- project/gui/awtk/src/base/native_window.h | 2 +- project/gui/awtk/src/base/self_layouter.h | 6 +++--- project/gui/awtk/src/base/text_edit.h | 2 +- project/gui/awtk/src/base/timer.h | 2 +- project/gui/awtk/src/base/widget_animator_manager.h | 2 +- project/gui/awtk/src/conf_io/conf_node.h | 4 ++-- project/gui/awtk/src/csv/csv_file.h | 2 +- project/gui/awtk/src/debugger/debugger_fscript.h | 4 ++-- .../src/ext_widgets/mutable_image/mutable_image.h | 4 ++-- project/gui/awtk/src/fscript_ext/fscript_array.h | 2 +- project/gui/awtk/src/hal/network_interface.h | 2 +- project/gui/awtk/src/lcd/lcd_mem.h | 2 +- project/gui/awtk/src/tkc/asset_info.h | 4 ++-- project/gui/awtk/src/tkc/color.h | 4 ++-- project/gui/awtk/src/tkc/color_parser.h | 2 +- project/gui/awtk/src/tkc/emitter.h | 2 +- .../gui/awtk/src/tkc/event_source_manager_default.h | 2 +- project/gui/awtk/src/tkc/fs.h | 8 ++++---- project/gui/awtk/src/tkc/idle_manager.h | 2 +- project/gui/awtk/src/tkc/mem_allocator.h | 2 +- project/gui/awtk/src/tkc/named_value.h | 8 ++++---- project/gui/awtk/src/tkc/path.h | 4 ++-- project/gui/awtk/src/tkc/rom_fs.h | 4 ++-- project/gui/awtk/src/tkc/slist.h | 4 ++-- project/gui/awtk/src/tkc/state_machine.h | 4 ++-- project/gui/awtk/src/tkc/timer_manager.h | 2 +- project/gui/awtk/src/tkc/tokenizer.h | 12 ++++++------ project/gui/awtk/src/tkc/typed_array.h | 2 +- project/gui/awtk/src/tkc/value.h | 4 ++-- project/gui/awtk/src/ubjson/ubjson_parser.h | 2 +- .../awtk/src/window_manager/window_manager_default.h | 2 +- 41 files changed, 69 insertions(+), 69 deletions(-) diff --git a/project/gui/awtk/src/base/assets_manager.h b/project/gui/awtk/src/base/assets_manager.h index 9373f7b93..2ecc8efad 100644 --- a/project/gui/awtk/src/base/assets_manager.h +++ b/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); diff --git a/project/gui/awtk/src/base/bidi.h b/project/gui/awtk/src/base/bidi.h index 8b6f4a217..846e199f5 100644 --- a/project/gui/awtk/src/base/bidi.h +++ b/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); diff --git a/project/gui/awtk/src/base/canvas_offline.h b/project/gui/awtk/src/base/canvas_offline.h index ae7d3bc7d..023c751ab 100644 --- a/project/gui/awtk/src/base/canvas_offline.h +++ b/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); diff --git a/project/gui/awtk/src/base/children_layouter.h b/project/gui/awtk/src/base/children_layouter.h index aae4235b2..8adfb0cc2 100644 --- a/project/gui/awtk/src/base/children_layouter.h +++ b/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); diff --git a/project/gui/awtk/src/base/clip_board.h b/project/gui/awtk/src/base/clip_board.h index 61a97fbae..49ffe8bec 100644 --- a/project/gui/awtk/src/base/clip_board.h +++ b/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); diff --git a/project/gui/awtk/src/base/font.h b/project/gui/awtk/src/base/font.h index 382024d42..65a874038 100644 --- a/project/gui/awtk/src/base/font.h +++ b/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); diff --git a/project/gui/awtk/src/base/g2d.h b/project/gui/awtk/src/base/g2d.h index 0087d5560..b707877e4 100644 --- a/project/gui/awtk/src/base/g2d.h +++ b/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 目标图片对象。 diff --git a/project/gui/awtk/src/base/gradient.h b/project/gui/awtk/src/base/gradient.h index c4096cc78..58321252d 100644 --- a/project/gui/awtk/src/base/gradient.h +++ b/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); diff --git a/project/gui/awtk/src/base/idle.h b/project/gui/awtk/src/base/idle.h index 73ab0a15c..913513872 100644 --- a/project/gui/awtk/src/base/idle.h +++ b/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); diff --git a/project/gui/awtk/src/base/input_engine.h b/project/gui/awtk/src/base/input_engine.h index 57ecceae0..970307751 100644 --- a/project/gui/awtk/src/base/input_engine.h +++ b/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 输入法引擎对象。 diff --git a/project/gui/awtk/src/base/native_window.h b/project/gui/awtk/src/base/native_window.h index 0a34f68c6..c820d51aa 100644 --- a/project/gui/awtk/src/base/native_window.h +++ b/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); diff --git a/project/gui/awtk/src/base/self_layouter.h b/project/gui/awtk/src/base/self_layouter.h index d651457ca..2eba80423 100644 --- a/project/gui/awtk/src/base/self_layouter.h +++ b/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); diff --git a/project/gui/awtk/src/base/text_edit.h b/project/gui/awtk/src/base/text_edit.h index 07cab6b06..3ca6caaaf 100644 --- a/project/gui/awtk/src/base/text_edit.h +++ b/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); diff --git a/project/gui/awtk/src/base/timer.h b/project/gui/awtk/src/base/timer.h index de3c589e7..5e0229e53 100644 --- a/project/gui/awtk/src/base/timer.h +++ b/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); diff --git a/project/gui/awtk/src/base/widget_animator_manager.h b/project/gui/awtk/src/base/widget_animator_manager.h index 2b3a7a43b..071ed2651 100644 --- a/project/gui/awtk/src/base/widget_animator_manager.h +++ b/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); diff --git a/project/gui/awtk/src/conf_io/conf_node.h b/project/gui/awtk/src/conf_io/conf_node.h index b975cbdfd..bddc52ba8 100644 --- a/project/gui/awtk/src/conf_io/conf_node.h +++ b/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); diff --git a/project/gui/awtk/src/csv/csv_file.h b/project/gui/awtk/src/csv/csv_file.h index 47c6c3905..43b120948 100644 --- a/project/gui/awtk/src/csv/csv_file.h +++ b/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); diff --git a/project/gui/awtk/src/debugger/debugger_fscript.h b/project/gui/awtk/src/debugger/debugger_fscript.h index 84aa5f62f..72ffe38f1 100644 --- a/project/gui/awtk/src/debugger/debugger_fscript.h +++ b/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); diff --git a/project/gui/awtk/src/ext_widgets/mutable_image/mutable_image.h b/project/gui/awtk/src/ext_widgets/mutable_image/mutable_image.h index bf19b895a..7006f2f28 100644 --- a/project/gui/awtk/src/ext_widgets/mutable_image/mutable_image.h +++ b/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); diff --git a/project/gui/awtk/src/fscript_ext/fscript_array.h b/project/gui/awtk/src/fscript_ext/fscript_array.h index e95264724..525481c73 100644 --- a/project/gui/awtk/src/fscript_ext/fscript_array.h +++ b/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); diff --git a/project/gui/awtk/src/hal/network_interface.h b/project/gui/awtk/src/hal/network_interface.h index 21a4b72d0..d6c5a76fc 100644 --- a/project/gui/awtk/src/hal/network_interface.h +++ b/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); diff --git a/project/gui/awtk/src/lcd/lcd_mem.h b/project/gui/awtk/src/lcd/lcd_mem.h index f17b25170..a13b99acc 100644 --- a/project/gui/awtk/src/lcd/lcd_mem.h +++ b/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 diff --git a/project/gui/awtk/src/tkc/asset_info.h b/project/gui/awtk/src/tkc/asset_info.h index 6c967f642..ac0be4712 100644 --- a/project/gui/awtk/src/tkc/asset_info.h +++ b/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); diff --git a/project/gui/awtk/src/tkc/color.h b/project/gui/awtk/src/tkc/color.h index 7815c6b1f..1eab3f0c9 100644 --- a/project/gui/awtk/src/tkc/color.h +++ b/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]); diff --git a/project/gui/awtk/src/tkc/color_parser.h b/project/gui/awtk/src/tkc/color_parser.h index 399616384..d44b4dcdb 100644 --- a/project/gui/awtk/src/tkc/color_parser.h +++ b/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); diff --git a/project/gui/awtk/src/tkc/emitter.h b/project/gui/awtk/src/tkc/emitter.h index 59d553ed5..aed138efd 100644 --- a/project/gui/awtk/src/tkc/emitter.h +++ b/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); diff --git a/project/gui/awtk/src/tkc/event_source_manager_default.h b/project/gui/awtk/src/tkc/event_source_manager_default.h index a7c03ee94..1b0c82398 100644 --- a/project/gui/awtk/src/tkc/event_source_manager_default.h +++ b/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); diff --git a/project/gui/awtk/src/tkc/fs.h b/project/gui/awtk/src/tkc/fs.h index 99523f4e7..47c13e242 100644 --- a/project/gui/awtk/src/tkc/fs.h +++ b/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); diff --git a/project/gui/awtk/src/tkc/idle_manager.h b/project/gui/awtk/src/tkc/idle_manager.h index 073cb6d33..3586c81b4 100644 --- a/project/gui/awtk/src/tkc/idle_manager.h +++ b/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); diff --git a/project/gui/awtk/src/tkc/mem_allocator.h b/project/gui/awtk/src/tkc/mem_allocator.h index 35ca7af38..ad253b552 100644 --- a/project/gui/awtk/src/tkc/mem_allocator.h +++ b/project/gui/awtk/src/tkc/mem_allocator.h @@ -103,7 +103,7 @@ static inline void* mem_allocator_realloc(mem_allocator_t* allocator, void* ptr, * @param {mem_allocator_t*} allocator allocator对象。 * @param {void*} ptr 内存的地址。 * - * @return {void*} 成功返回内存块的地址,失败返回NULL。 + * @return {void} 无。 */ static inline void mem_allocator_free(mem_allocator_t* allocator, void* ptr) { return_if_fail(allocator != NULL && allocator->vt != NULL && allocator->vt->free != NULL); diff --git a/project/gui/awtk/src/tkc/named_value.h b/project/gui/awtk/src/tkc/named_value.h index 1141ea935..8a06bfed1 100644 --- a/project/gui/awtk/src/tkc/named_value.h +++ b/project/gui/awtk/src/tkc/named_value.h @@ -67,7 +67,7 @@ named_value_t* named_value_create(void); * @param {const char*} name 名称。 * @param {const value_t*} value 值。 * - * @return {ret_t} 返回named_value对象。 + * @return {named_value_t*} 返回named_value对象。 */ named_value_t* named_value_create_ex(const char* name, const value_t* value); @@ -81,7 +81,7 @@ named_value_t* named_value_create_ex(const char* name, const value_t* value); * @param {const char*} name 名称。 * @param {const value_t*} value 值。 * - * @return {ret_t} 返回named_value对象。 + * @return {named_value_t*} 返回named_value对象。 */ named_value_t* named_value_init(named_value_t* nv, const char* name, const value_t* value); @@ -156,7 +156,7 @@ ret_t named_value_deinit(named_value_t* nv); * @param {named_value_t*} nv named_value对象。 * @param {named_value_t*} other named_value对象。 * - * @return {ret_t} 返回RET_OK表示成功,否则表示失败。 + * @return {int32_t} 返回RET_OK表示成功,否则表示失败。 */ int32_t named_value_compare(named_value_t* nv, const named_value_t* other); @@ -168,7 +168,7 @@ int32_t named_value_compare(named_value_t* nv, const named_value_t* other); * @param {named_value_t*} nv named_value对象。 * @param {const char*} name 名称。 * - * @return {ret_t} 返回RET_OK表示成功,否则表示失败。 + * @return {int32_t} 返回RET_OK表示成功,否则表示失败。 */ int32_t named_value_compare_by_name(named_value_t* nv, const char* name); diff --git a/project/gui/awtk/src/tkc/path.h b/project/gui/awtk/src/tkc/path.h index f5d5b619b..168ab37cd 100644 --- a/project/gui/awtk/src/tkc/path.h +++ b/project/gui/awtk/src/tkc/path.h @@ -134,7 +134,7 @@ ret_t path_abs(const char* path, char* result, int32_t size); * * @param {const char*} path 路径。 * - * @return {ret_t} 返回FALSE表示不是绝对路径,否则表示是绝对路径。 + * @return {bool_t} 返回FALSE表示不是绝对路径,否则表示是绝对路径。 */ bool_t path_is_abs(const char* path); @@ -232,7 +232,7 @@ ret_t path_app_root_ex(char path[MAX_PATH + 1], const char* subpath); * * @param {const char*} path 目录。 * - * @return {ret_t} 返回TRUE表示成功,否则表示失败。 + * @return {bool_t} 返回TRUE表示成功,否则表示失败。 */ bool_t path_exist(const char* path); diff --git a/project/gui/awtk/src/tkc/rom_fs.h b/project/gui/awtk/src/tkc/rom_fs.h index 05a4df5a0..3f7457097 100644 --- a/project/gui/awtk/src/tkc/rom_fs.h +++ b/project/gui/awtk/src/tkc/rom_fs.h @@ -59,7 +59,7 @@ typedef struct _rom_file_t { * @param {const char*} name 文件名。 * @param {const char*} mode 打开方式。 * - * @return {ret_t} 返回不是NULL表示成功,否则表示失败。 + * @return {rom_file_t*} 返回不是NULL表示成功,否则表示失败。 */ rom_file_t* rom_fopen(const char* name, const char* mode); @@ -69,7 +69,7 @@ rom_file_t* rom_fopen(const char* name, const char* mode); * @param {const uint8_t*} data 数据。 * @param {uint32_t} capacity 容量。 * - * @return {ret_t} 返回RET_OK表示成功,否则表示失败。 + * @return {rom_file_t*} 打开成功则返回rom_file_t对象,否则返回NULL。 */ rom_file_t* rom_fopen_buff(const uint8_t* data, uint32_t capacity); diff --git a/project/gui/awtk/src/tkc/slist.h b/project/gui/awtk/src/tkc/slist.h index 20dfc6041..93db306ad 100644 --- a/project/gui/awtk/src/tkc/slist.h +++ b/project/gui/awtk/src/tkc/slist.h @@ -191,7 +191,7 @@ ret_t slist_foreach(slist_t* slist, tk_visit_t visit, void* ctx); * 弹出最后一个元素。 * @param {slist_t*} slist 单向链表对象。 * - * @return {ret_t} 成功返回最后一个元素,失败返回NULL。 + * @return {void*} 成功返回最后一个元素,失败返回NULL。 */ void* slist_tail_pop(slist_t* slist); @@ -200,7 +200,7 @@ void* slist_tail_pop(slist_t* slist); * 弹出第一个元素。 * @param {slist_t*} slist 单向链表对象。 * - * @return {ret_t} 成功返回最后一个元素,失败返回NULL。 + * @return {void*} 成功返回最后一个元素,失败返回NULL。 */ void* slist_head_pop(slist_t* slist); diff --git a/project/gui/awtk/src/tkc/state_machine.h b/project/gui/awtk/src/tkc/state_machine.h index 8859fe579..6641e74f4 100644 --- a/project/gui/awtk/src/tkc/state_machine.h +++ b/project/gui/awtk/src/tkc/state_machine.h @@ -95,7 +95,7 @@ ret_t tk_state_machine_handle(tk_state_machine_t* fsm, tk_sm_event_t* event); * * @param {tk_state_machine_t*} fsm 状态机地址 * - * @return {tk_sm_state_t*} 返回 tk_sm_state_t 对象 + * @return {const tk_sm_state_t*} 返回 tk_sm_state_t 对象 */ const tk_sm_state_t* tk_state_machine_previous_get(tk_state_machine_t* fsm); /** @@ -104,7 +104,7 @@ const tk_sm_state_t* tk_state_machine_previous_get(tk_state_machine_t* fsm); * * @param {tk_state_machine_t*} fsm 状态机地址 * - * @return {tk_sm_state_t*} 返回 tk_sm_state_t 对象 + * @return {const tk_sm_state_t*} 返回 tk_sm_state_t 对象 */ const tk_sm_state_t* tk_state_machine_current_get(tk_state_machine_t* fsm); /** diff --git a/project/gui/awtk/src/tkc/timer_manager.h b/project/gui/awtk/src/tkc/timer_manager.h index 85b27a54c..71a224b38 100644 --- a/project/gui/awtk/src/tkc/timer_manager.h +++ b/project/gui/awtk/src/tkc/timer_manager.h @@ -160,7 +160,7 @@ ret_t timer_manager_reset(timer_manager_t* timer_manager, uint32_t timer_id); * @param {timer_manager_t*} timer_manager 定时器管理器对象。 * @param {uint32_t} timer_id timer_id * - * @return {timer_info_t*} 返回timer的信息。 + * @return {const timer_info_t*} 返回timer的信息。 */ const timer_info_t* timer_manager_find(timer_manager_t* timer_manager, uint32_t timer_id); diff --git a/project/gui/awtk/src/tkc/tokenizer.h b/project/gui/awtk/src/tkc/tokenizer.h index d576bbe0f..e473d5532 100644 --- a/project/gui/awtk/src/tkc/tokenizer.h +++ b/project/gui/awtk/src/tkc/tokenizer.h @@ -122,7 +122,7 @@ bool_t tokenizer_has_more(tokenizer_t* tokenizer); * 获取下一个token。 * @param {tokenizer_t*} tokenizer tokenizer对象。 * - * @return {char*} 成功返回token,失败返回NULL。 + * @return {const char*} 成功返回token,失败返回NULL。 */ const char* tokenizer_next(tokenizer_t* tokenizer); @@ -131,7 +131,7 @@ const char* tokenizer_next(tokenizer_t* tokenizer); * 获取下一个字符串(允许使用英文单引号和双引号界定字符串)。 * @param {tokenizer_t*} tokenizer tokenizer对象。 * - * @return {char*} 成功返回字符串,失败返回NULL。 + * @return {const char*} 成功返回字符串,失败返回NULL。 */ const char* tokenizer_next_str(tokenizer_t* tokenizer); @@ -141,7 +141,7 @@ const char* tokenizer_next_str(tokenizer_t* tokenizer); * @param {tokenizer_t*} tokenizer tokenizer对象。 * @param {const char*} str 字符集。 * - * @return {char*} 成功返回token,失败返回NULL。 + * @return {const char*} 成功返回token,失败返回NULL。 */ const char* tokenizer_next_until(tokenizer_t* tokenizer, const char* str); @@ -151,7 +151,7 @@ const char* tokenizer_next_until(tokenizer_t* tokenizer, const char* str); * @param {tokenizer_t*} tokenizer tokenizer对象。 * @param {const char*} str 字符集。 * - * @return {char*} 成功返回token,失败返回NULL。 + * @return {const char*} 成功返回token,失败返回NULL。 */ const char* tokenizer_next_expr_until(tokenizer_t* tokenizer, const char* str); @@ -161,7 +161,7 @@ const char* tokenizer_next_expr_until(tokenizer_t* tokenizer, const char* str); * @param {tokenizer_t*} tokenizer tokenizer对象。 * @param {int} defval 缺省值。 * - * @return {char*} 成功返回token的int值,失败返回缺省值。 + * @return {int} 成功返回token的int值,失败返回缺省值。 */ int tokenizer_next_int(tokenizer_t* tokenizer, int defval); @@ -171,7 +171,7 @@ int tokenizer_next_int(tokenizer_t* tokenizer, int defval); * @param {tokenizer_t*} tokenizer tokenizer对象。 * @param {float} defval 缺省值。 * - * @return {char*} 成功返回token的float值,失败返回缺省值。 + * @return {float} 成功返回token的float值,失败返回缺省值。 */ float tokenizer_next_float(tokenizer_t* tokenizer, float defval); diff --git a/project/gui/awtk/src/tkc/typed_array.h b/project/gui/awtk/src/tkc/typed_array.h index f0d985d4e..fdc6b284a 100644 --- a/project/gui/awtk/src/tkc/typed_array.h +++ b/project/gui/awtk/src/tkc/typed_array.h @@ -147,7 +147,7 @@ ret_t typed_array_remove(typed_array_t* typed_array, uint32_t index); * 弹出最后一个元素。 * @param {typed_array_t*} typed_array 数组对象。 * - * @return {void*} 成功返回最后一个元素,失败返回NULL。 + * @return {ret_t} 返回RET_OK表示成功,否则表示失败。 */ ret_t typed_array_pop(typed_array_t* typed_array, value_t* v); diff --git a/project/gui/awtk/src/tkc/value.h b/project/gui/awtk/src/tkc/value.h index 1e57d6ab8..9c43a4f90 100644 --- a/project/gui/awtk/src/tkc/value.h +++ b/project/gui/awtk/src/tkc/value.h @@ -303,7 +303,7 @@ value_t* value_set_uint8(value_t* v, uint8_t value); * @annotation ["scriptable"] * @param {value_t*} v value对象。 * - * @return {int8_t} 值。 + * @return {uint8_t} 值。 */ uint8_t value_uint8(const value_t* v); @@ -911,7 +911,7 @@ value_t* value_set_func_def(value_t* v, void* value); * @annotation ["scriptable"] * @param {value_t*} v value对象。 * - * @return {bitmap_t*} 位图对象。 + * @return {void*} 位图对象。 */ void* value_bitmap(const value_t* v); diff --git a/project/gui/awtk/src/ubjson/ubjson_parser.h b/project/gui/awtk/src/ubjson/ubjson_parser.h index fe4280f65..5239ae0d5 100644 --- a/project/gui/awtk/src/ubjson/ubjson_parser.h +++ b/project/gui/awtk/src/ubjson/ubjson_parser.h @@ -59,7 +59,7 @@ ret_t ubjson_parse(void* data, uint32_t size, ubjson_on_key_value_t on_key_value * @param {void*} data 数据。 * @param {uint32_t} size 数据的长度。 * - * @return {void*} 返回object表示的数据。 + * @return {tk_object_t*} 返回object表示的数据。 */ tk_object_t* ubjson_to_object(void* data, uint32_t size); diff --git a/project/gui/awtk/src/window_manager/window_manager_default.h b/project/gui/awtk/src/window_manager/window_manager_default.h index e0a0e97d5..f74b2d1f0 100644 --- a/project/gui/awtk/src/window_manager/window_manager_default.h +++ b/project/gui/awtk/src/window_manager/window_manager_default.h @@ -76,7 +76,7 @@ typedef struct _window_manager_default_t { * 创建窗口管理器。 * @annotation ["constructor"] * - * @return {window_manager_t*} 返回窗口管理器对象。 + * @return {widget_t*} 返回窗口管理器对象。 */ widget_t* window_manager_create(void);