mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-11-30 11:08:34 +08:00
improve api docs
This commit is contained in:
parent
eda88c1148
commit
3796c88422
@ -87,11 +87,11 @@ ret_t tk_quit(void);
|
||||
* @alias global_quit_ex
|
||||
* @annotation ["static", "scriptable"]
|
||||
*
|
||||
* @param {uint32_t} delay_ms 延迟退出的时间。
|
||||
* @param {uint32_t} delay 延迟退出的时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
ret_t tk_quit_ex(uint32_t delay_ms);
|
||||
ret_t tk_quit_ex(uint32_t delay);
|
||||
|
||||
/**
|
||||
* @method tk_get_pointer_x
|
||||
|
@ -66,7 +66,7 @@ ret_t timer_prepare(timer_get_time_t get_time);
|
||||
* @annotation ["scriptable:custom", "static"]
|
||||
* @param {timer_func_t} on_timer timer回调函数。
|
||||
* @param {void*} ctx timer回调函数的上下文。
|
||||
* @param {uint32_t} duration 时间。
|
||||
* @param {uint32_t} duration 时间(毫秒)。
|
||||
*
|
||||
* @return {uint32_t} 返回timer的ID,TK_INVALID_ID表示失败。
|
||||
*/
|
||||
@ -78,7 +78,7 @@ uint32_t timer_add(timer_func_t on_timer, void* ctx, uint32_t duration);
|
||||
* @annotation ["static"]
|
||||
* @param {timer_func_t} on_timer timer回调函数,回调函数返回RET_REPEAT,则下次继续执行,否则自动移出。
|
||||
* @param {void*} ctx timer回调函数的上下文。
|
||||
* @param {uint32_t} duration 时间。
|
||||
* @param {uint32_t} duration 时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
@ -90,7 +90,7 @@ ret_t timer_queue(timer_func_t on_timer, void* ctx, uint32_t duration);
|
||||
* @annotation ["static"]
|
||||
* @param {timer_func_t} on_timer timer回调函数,回调函数返回RET_REPEAT,则下次继续执行,否则自动移出。
|
||||
* @param {void*} ctx timer回调函数的上下文。
|
||||
* @param {uint32_t} duration 时间。
|
||||
* @param {uint32_t} duration 时间(毫秒)。
|
||||
* @param {tk_destroy_t} on_destroy 回调函数。
|
||||
* @param {void*} on_destroy_ctx 回调函数上下文。
|
||||
*
|
||||
@ -154,7 +154,7 @@ ret_t timer_resume(uint32_t timer_id);
|
||||
* 修改指定的timer的duration,修改之后定时器重新开始计时。
|
||||
* @annotation ["scriptable", "static"]
|
||||
* @param {uint32_t} timer_id timerID。
|
||||
* @param {uint32_t} duration 新的时间。
|
||||
* @param {uint32_t} duration 新的时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
@ -200,10 +200,10 @@ uint32_t timer_count(void);
|
||||
|
||||
/**
|
||||
* @method timer_next_time
|
||||
* 返回最近的timer到期时间。
|
||||
* 返回最近的timer到期时间(毫秒)。
|
||||
* @annotation ["static"]
|
||||
*
|
||||
* @return {uint32_t} 返回最近的timer到期时间。
|
||||
* @return {uint32_t} 返回最近的timer到期时间(毫秒)。
|
||||
*/
|
||||
uint32_t timer_next_time(void);
|
||||
|
||||
|
@ -57,7 +57,7 @@ velocity_t* velocity_reset(velocity_t* v);
|
||||
* 更新位置。
|
||||
*
|
||||
* @param {velocity_t*} v velocity对象。
|
||||
* @param {uint64_t} time 时间。
|
||||
* @param {uint64_t} time 时间(毫秒)。
|
||||
* @param {xy_t} x x坐标。
|
||||
* @param {xy_t} y y坐标。
|
||||
*
|
||||
|
@ -2372,7 +2372,7 @@ bool_t widget_equal(widget_t* widget, widget_t* other);
|
||||
* 如果定时器的生命周期与控件无关,请直接调用**timer_add**,以避免不必要的内存开销。
|
||||
* @param {widget_t*} widget 控件对象。
|
||||
* @param {timer_func_t} on_timer timer回调函数。
|
||||
* @param {uint32_t} duration_ms 时间。
|
||||
* @param {uint32_t} duration 时间(毫秒)。
|
||||
*
|
||||
* 使用示例:
|
||||
*
|
||||
@ -2389,7 +2389,7 @@ bool_t widget_equal(widget_t* widget, widget_t* other);
|
||||
*
|
||||
* @return {uint32_t} 返回timer的ID,TK_INVALID_ID表示失败。
|
||||
*/
|
||||
uint32_t widget_add_timer(widget_t* widget, timer_func_t on_timer, uint32_t duration_ms);
|
||||
uint32_t widget_add_timer(widget_t* widget, timer_func_t on_timer, uint32_t duration);
|
||||
|
||||
/**
|
||||
* @method widget_remove_timer
|
||||
|
@ -190,8 +190,8 @@ struct _widget_animator_t {
|
||||
* 初始化。仅供子类内部使用。
|
||||
* @param {widget_animator_t*} animator 动画对象。
|
||||
* @param {widget_t*} widget 控件对象。
|
||||
* @param {uint32_t} duration 动画持续时间。
|
||||
* @param {uint32_t} delay 动画执行时间。
|
||||
* @param {uint32_t} duration 动画持续时间(毫秒)。
|
||||
* @param {uint32_t} delay 动画执行时间(毫秒)。
|
||||
* @param {easing_func_t} easing 插值函数。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
|
@ -585,7 +585,7 @@ BEGIN_C_DECLS
|
||||
|
||||
/**
|
||||
* @const WIDGET_PROP_AUTO_PLAY
|
||||
* 是否自动播放或指定播放的时间。
|
||||
* 是否自动播放或指定播放的时间(毫秒)。
|
||||
*/
|
||||
#define WIDGET_PROP_AUTO_PLAY "auto_play"
|
||||
|
||||
@ -759,7 +759,7 @@ BEGIN_C_DECLS
|
||||
|
||||
/**
|
||||
* @const WIDGET_PROP_LONG_PRESS_TIME
|
||||
* 触发长按事件的时间(ms)。
|
||||
* 触发长按事件的时间(毫秒)。
|
||||
*/
|
||||
#define WIDGET_PROP_LONG_PRESS_TIME "long_press_time"
|
||||
|
||||
@ -1059,7 +1059,7 @@ BEGIN_C_DECLS
|
||||
|
||||
/**
|
||||
* @const WIDGET_PROP_ANIMATING_TIME
|
||||
* 动画时间。
|
||||
* 动画时间(毫秒)。
|
||||
*/
|
||||
#define WIDGET_PROP_ANIMATING_TIME "animating_time"
|
||||
|
||||
@ -1071,7 +1071,7 @@ BEGIN_C_DECLS
|
||||
|
||||
/**
|
||||
* @const WIDGET_PROP_ANIMATE_ANIMATING_TIME
|
||||
* 改变控件属性时附带动画的播放时间。
|
||||
* 改变控件属性时附带动画的播放时间(毫秒)。
|
||||
*/
|
||||
#define WIDGET_PROP_ANIMATE_ANIMATING_TIME "animate:animating_time"
|
||||
|
||||
@ -1083,7 +1083,7 @@ BEGIN_C_DECLS
|
||||
|
||||
/**
|
||||
* @const WIDGET_PROP_SCREEN_SAVER_TIME
|
||||
* 屏幕保护时间。
|
||||
* 屏幕保护时间(毫秒)。
|
||||
*/
|
||||
#define WIDGET_PROP_SCREEN_SAVER_TIME "screen_saver_time"
|
||||
|
||||
|
@ -354,7 +354,7 @@ ret_t window_manager_set_ignore_input_events(widget_t* widget, bool_t ignore_inp
|
||||
|
||||
/**
|
||||
* @method window_manager_set_screen_saver_time
|
||||
* 设置屏保时间。
|
||||
* 设置屏保时间(毫秒)。
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget 窗口管理器对象。
|
||||
* @param {uint32_t} screen_saver_time 屏保时间(单位毫秒), 为0关闭屏保。
|
||||
|
@ -558,7 +558,7 @@ ret_t debugger_set_current_thread_id(debugger_t* debugger, uint64_t thread_id);
|
||||
* @method debugger_dispatch_messages
|
||||
* dispatch_messages(仅适用于客户端)
|
||||
* @param {debugger_t*} debugger debugger对象。
|
||||
* @param {uint32_t} timeout 超时时间。
|
||||
* @param {uint32_t} timeout 超时时间(毫秒)。
|
||||
* @param {uint32_t*} ret_num 返回处理命令个数。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
|
@ -196,7 +196,7 @@ ret_t image_animation_set_image(widget_t* widget, const char* image);
|
||||
|
||||
/**
|
||||
* @method image_animation_set_interval
|
||||
* 设置播放间隔时间。
|
||||
* 设置播放间隔时间(毫秒)。
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget image_animation对象。
|
||||
* @param {uint32_t} interval 间隔时间(毫秒)。
|
||||
|
@ -94,14 +94,14 @@ typedef struct _hscroll_label_t {
|
||||
/**
|
||||
* @property {int32_t} lull
|
||||
* @annotation ["set_prop","get_prop","readable","persitent","design","scriptable"]
|
||||
* 滚动之间的间歇时间(ms),缺省3000ms。
|
||||
* 滚动之间的间歇时间(毫秒),缺省3000ms。
|
||||
*/
|
||||
int32_t lull;
|
||||
|
||||
/**
|
||||
* @property {int32_t} duration
|
||||
* @annotation ["set_prop","get_prop","readable","scriptable"]
|
||||
* 完整的滚动一次需要的时间(ms),缺省5000ms。
|
||||
* 完整的滚动一次需要的时间(毫秒),缺省5000ms。
|
||||
*/
|
||||
int32_t duration;
|
||||
|
||||
@ -162,7 +162,7 @@ widget_t* hscroll_label_create(widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h)
|
||||
* 设置lull。
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget 控件对象。
|
||||
* @param {int32_t} lull 间歇时间(ms)。
|
||||
* @param {int32_t} lull 间歇时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
@ -173,7 +173,7 @@ ret_t hscroll_label_set_lull(widget_t* widget, int32_t lull);
|
||||
* 设置duration。
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget 控件对象。
|
||||
* @param {int32_t} duration 滚动时间(ms)。
|
||||
* @param {int32_t} duration 滚动时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
|
@ -92,7 +92,7 @@ typedef struct _scroll_bar_t {
|
||||
/**
|
||||
* @property {uint32_t} animator_time
|
||||
* @annotation ["set_prop","get_prop","readable","persitent","design","scriptable"]
|
||||
* 翻页滚动动画时间。
|
||||
* 翻页滚动动画时间(毫秒)。
|
||||
*/
|
||||
uint32_t animator_time;
|
||||
/**
|
||||
@ -197,7 +197,7 @@ ret_t scroll_bar_set_params(widget_t* widget, int32_t virtual_size, int32_t row)
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget scroll_bar控件。
|
||||
* @param {int32_t} value 值。
|
||||
* @param {int32_t} duration 动画持续时间。
|
||||
* @param {int32_t} duration 动画持续时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
@ -273,11 +273,11 @@ bool_t scroll_bar_is_mobile(widget_t* widget);
|
||||
|
||||
/**
|
||||
* @method scroll_bar_set_animator_time
|
||||
* 设置翻页滚动动画时间。
|
||||
* 设置翻页滚动动画时间(毫秒)。
|
||||
*
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget scroll_bar控件。
|
||||
* @param {uint32_t} animator_time 时间。
|
||||
* @param {uint32_t} animator_time 时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
@ -289,8 +289,8 @@ ret_t scroll_bar_set_animator_time(widget_t* widget, uint32_t animator_time);
|
||||
*
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget scroll_bar控件。
|
||||
* @param {int32_t} duration 动画持续时间。
|
||||
* @param {int32_t} delay 动画执行时间。
|
||||
* @param {int32_t} duration 动画持续时间(毫秒)。
|
||||
* @param {int32_t} delay 动画执行时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
@ -302,8 +302,8 @@ ret_t scroll_bar_hide_by_opacity_animation(widget_t* widget, int32_t duration, i
|
||||
*
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget scroll_bar控件。
|
||||
* @param {int32_t} duration 动画持续时间。
|
||||
* @param {int32_t} delay 动画执行时间。
|
||||
* @param {int32_t} duration 动画持续时间(毫秒)。
|
||||
* @param {int32_t} delay 动画执行时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
|
@ -351,7 +351,7 @@ ret_t scroll_view_set_slide_limit_ratio(widget_t* widget, float_t slide_limit_ra
|
||||
* @param {widget_t*} widget 控件对象。
|
||||
* @param {int32_t} xoffset_end x偏移量。
|
||||
* @param {int32_t} yoffset_end y偏移量。
|
||||
* @param {int32_t} duration 时间。
|
||||
* @param {int32_t} duration 时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
@ -365,7 +365,7 @@ ret_t scroll_view_scroll_to(widget_t* widget, int32_t xoffset_end, int32_t yoffs
|
||||
* @param {widget_t*} widget 控件对象。
|
||||
* @param {int32_t} xoffset_delta x偏移量。
|
||||
* @param {int32_t} yoffset_delta y偏移量。
|
||||
* @param {int32_t} duration 时间。
|
||||
* @param {int32_t} duration 时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
|
@ -227,7 +227,7 @@ ret_t serial_widget_set_flowcontrol(widget_t* widget, uint32_t flowcontrol);
|
||||
|
||||
/**
|
||||
* @method serial_widget_set_check_interval
|
||||
* 设置 轮询时间。
|
||||
* 设置 轮询时间(毫秒)。
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget widget对象。
|
||||
* @param {uint32_t} check_interval 轮询时间(单位:ms)。
|
||||
|
@ -89,7 +89,7 @@ typedef struct _slide_view_t {
|
||||
/**
|
||||
* @property {uint16_t} auto_play
|
||||
* @annotation ["set_prop","get_prop","readable","persitent","design","scriptable"]
|
||||
* 自动播放。0表示禁止自动播放,非0表示自动播放时每一页播放的时间。
|
||||
* 自动播放。0表示禁止自动播放,非0表示自动播放时每一页播放的时间(毫秒)。
|
||||
*/
|
||||
uint16_t auto_play;
|
||||
|
||||
@ -204,7 +204,7 @@ widget_t* slide_view_cast(widget_t* widget);
|
||||
* 设置为自动播放模式。
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget slide_view对象。
|
||||
* @param {uint16_t} auto_play 0表示禁止自动播放,非0表示自动播放时每一页播放的时间。
|
||||
* @param {uint16_t} auto_play 0表示禁止自动播放,非0表示自动播放时每一页播放的时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
@ -291,10 +291,10 @@ ret_t slide_view_set_drag_threshold(widget_t* widget, uint32_t drag_threshold);
|
||||
|
||||
/**
|
||||
* @method slide_view_set_animating_time
|
||||
* 设置动画时间。
|
||||
* 设置动画时间(毫秒)。
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget slide_view对象。
|
||||
* @param {uint32_t} animating_time 动画时间。
|
||||
* @param {uint32_t} animating_time 动画时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
|
@ -56,7 +56,7 @@ typedef struct _timer_widget_t {
|
||||
/**
|
||||
* @property {uint32_t} duration
|
||||
* @annotation ["set_prop","get_prop","readable","persitent","design","scriptable"]
|
||||
* 时长(ms)。
|
||||
* 时长(毫秒)。
|
||||
*/
|
||||
uint32_t duration;
|
||||
|
||||
@ -95,10 +95,10 @@ widget_t* timer_widget_cast(widget_t* widget);
|
||||
|
||||
/**
|
||||
* @method timer_widget_set_duration
|
||||
* 设置 时长(ms)。
|
||||
* 设置 时长(毫秒)。
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget widget对象。
|
||||
* @param {uint32_t} duration 时长(ms)。
|
||||
* @param {uint32_t} duration 时长(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
|
@ -101,10 +101,10 @@ ret_t tk_client_read_resp(tk_client_t* client, tk_msg_header_t* header, wbuffer_
|
||||
* @method tk_client_read_notify
|
||||
* 客户端读取通知。
|
||||
* @param {tk_client_t*} client client对象。
|
||||
* @param {uint32_t} timeout_ms 超时时间。
|
||||
* @param {uint32_t} timeout 超时时间(毫秒)。
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
ret_t tk_client_read_notify(tk_client_t* client, uint32_t timeout_ms);
|
||||
ret_t tk_client_read_notify(tk_client_t* client, uint32_t timeout);
|
||||
|
||||
/**
|
||||
* @method tk_client_request
|
||||
|
@ -96,7 +96,7 @@ struct _tk_ostream_retry_t {
|
||||
/**
|
||||
* @property {uint32_t} timeout
|
||||
* @annotation ["readable"]
|
||||
* 写超时时间(ms)。
|
||||
* 写超时时间(毫秒)。
|
||||
*/
|
||||
uint32_t timeout;
|
||||
/**
|
||||
|
@ -127,7 +127,7 @@ int process_handle_get_fd(process_handle_t handle);
|
||||
* 等待数据。
|
||||
*
|
||||
* @param {process_handle_t} handle 子进程句柄。
|
||||
* @param {uint32_t} timeout_ms 等待时间(ms)。
|
||||
* @param {uint32_t} timeout_ms 等待时间(毫秒)。
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
ret_t process_wait_for_data(process_handle_t handle, uint32_t timeout_ms);
|
||||
|
@ -110,7 +110,7 @@ ret_t tk_iostream_serial_config(tk_iostream_t* iostream, int32_t baudrate, bytes
|
||||
* @method tk_iostream_serial_wait_for_data
|
||||
* 等待串口数据。
|
||||
* @param {tk_iostream_t*} iostream 串口对象。
|
||||
* @param {uint32_t} timeout 等待时间(ms)。
|
||||
* @param {uint32_t} timeout 等待时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*
|
||||
|
@ -44,7 +44,7 @@ struct _tk_istream_shdlc_t {
|
||||
|
||||
/**
|
||||
* @property {uint32_t} timeout
|
||||
* 读写超时时间(ms)
|
||||
* 读写超时时间(毫秒)
|
||||
*/
|
||||
uint32_t timeout;
|
||||
/**
|
||||
|
@ -43,7 +43,7 @@ struct _tk_ostream_shdlc_t {
|
||||
|
||||
/**
|
||||
* @property {uint32_t} timeout
|
||||
* 读写超时时间(ms)
|
||||
* 读写超时时间(毫秒)
|
||||
*/
|
||||
uint32_t timeout;
|
||||
/**
|
||||
|
@ -158,7 +158,7 @@ ret_t action_darray_thread_set_strategy(action_darray_thread_t* thread,
|
||||
* @method action_darray_thread_set_idle_interval
|
||||
* 设置空闲时的时间间隔。
|
||||
* @param {action_darray_thread_t*} thread action_darray_thread对象。
|
||||
* @param {uint32_t} interval 时间间隔(ms)。
|
||||
* @param {uint32_t} interval 时间间隔(毫秒)。
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
ret_t action_darray_thread_set_idle_interval(action_darray_thread_t* thread, uint32_t interval);
|
||||
|
@ -54,14 +54,14 @@ ret_t tk_cond_wait(tk_cond_t* cond, tk_mutex_t* mutex);
|
||||
|
||||
/**
|
||||
* @method tk_cond_wait_timeout
|
||||
* 等待指定时间。
|
||||
* 等待指定时间(毫秒)。
|
||||
* @param {tk_cond_t*} cond cond对象。
|
||||
* @param {tk_mutex_t*} mutex mutex对象。
|
||||
* @param {uint32_t} ms 最长等待时间。
|
||||
* @param {uint32_t} timeout 最长等待时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
ret_t tk_cond_wait_timeout(tk_cond_t* cond, tk_mutex_t* mutex, uint32_t ms);
|
||||
ret_t tk_cond_wait_timeout(tk_cond_t* cond, tk_mutex_t* mutex, uint32_t timeout);
|
||||
|
||||
/**
|
||||
* @method tk_cond_signal
|
||||
|
@ -45,11 +45,11 @@ tk_cond_var_t* tk_cond_var_create(void);
|
||||
* @method tk_cond_var_wait
|
||||
* 等待。
|
||||
* @param {tk_cond_var_t*} cond_var cond_var对象。
|
||||
* @param {uint32_t} timeout_ms 最长等待时间。
|
||||
* @param {uint32_t} timeout 最长等待时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
ret_t tk_cond_var_wait(tk_cond_var_t* cond_var, uint32_t timeout_ms);
|
||||
ret_t tk_cond_var_wait(tk_cond_var_t* cond_var, uint32_t timeout);
|
||||
|
||||
/**
|
||||
* @method tk_cond_var_awake
|
||||
|
@ -41,7 +41,7 @@ typedef ret_t (*event_source_on_event_t)(event_source_t* source);
|
||||
* 事件源有下列两种方式:
|
||||
*
|
||||
* * 对于有文件描述符的事件源(如socket),get_fd返回一个有效的文件描述符。
|
||||
* * 对于定时器,则get_wakeup_time返回下次唤醒的时间。
|
||||
* * 对于定时器,则get_wakeup_time返回下次唤醒的时间(毫秒)。
|
||||
*
|
||||
*/
|
||||
struct _event_source_t {
|
||||
@ -108,11 +108,11 @@ ret_t event_source_check(event_source_t* source);
|
||||
/**
|
||||
* @method event_source_get_wakeup_time
|
||||
*
|
||||
* 获取唤醒时间(ms)。
|
||||
* 获取唤醒时间(毫秒)。
|
||||
*
|
||||
* @param {event_source_t*} source event_source对象。
|
||||
*
|
||||
* @return {uint32_t} 返回唤醒时间(ms)。
|
||||
* @return {uint32_t} 返回唤醒时间(毫秒)。
|
||||
*
|
||||
*/
|
||||
uint32_t event_source_get_wakeup_time(event_source_t* source);
|
||||
|
@ -73,11 +73,11 @@ ret_t event_source_manager_deinit(event_source_manager_t* manager);
|
||||
/**
|
||||
* @method event_source_manager_get_wakeup_time
|
||||
*
|
||||
* 获取wakeup时间(ms)
|
||||
* 获取wakeup时间(毫秒)
|
||||
*
|
||||
* @param {event_source_manager_t*} manager event_source_manager对象。
|
||||
*
|
||||
* @return {uint32_t} 返回wakeup时间(ms)。
|
||||
* @return {uint32_t} 返回wakeup时间(毫秒)。
|
||||
*
|
||||
*/
|
||||
uint32_t event_source_manager_get_wakeup_time(event_source_manager_t* manager);
|
||||
@ -136,7 +136,7 @@ ret_t event_source_manager_remove_by_tag(event_source_manager_t* manager, void*
|
||||
/**
|
||||
* @method event_source_manager_set_min_sleep_time
|
||||
*
|
||||
* 设置默认最小睡眠时间。
|
||||
* 设置默认最小睡眠时间(毫秒)。
|
||||
*
|
||||
* @param {event_source_manager_t*} manager event_source_manager对象。
|
||||
* @param {uint32_t} sleep_time 默认最小睡眠时间(毫秒)。
|
||||
|
@ -113,7 +113,7 @@ bool_t tk_istream_eos(tk_istream_t* stream);
|
||||
* 等待数据。
|
||||
*
|
||||
* @param {tk_istream_t*} stream istream对象。
|
||||
* @param {uint32_t} timeout_ms 超时时间。
|
||||
* @param {uint32_t} timeout_ms 超时时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*
|
||||
|
@ -47,11 +47,11 @@ tk_semaphore_t* tk_semaphore_create(uint32_t value, const char* name);
|
||||
* @method tk_semaphore_wait
|
||||
* 获取资源。
|
||||
* @param {tk_semaphore_t*} semaphore 信号量对象。
|
||||
* @param {uint32_t} timeout_ms 超时时间。
|
||||
* @param {uint32_t} timeout 超时时间(毫秒)。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
ret_t tk_semaphore_wait(tk_semaphore_t* semaphore, uint32_t timeout_ms);
|
||||
ret_t tk_semaphore_wait(tk_semaphore_t* semaphore, uint32_t timeout);
|
||||
|
||||
/**
|
||||
* @method tk_semaphore_post
|
||||
|
@ -285,7 +285,7 @@ ret_t serial_oflush(serial_handle_t handle);
|
||||
* 等待数据。
|
||||
*
|
||||
* @param {serial_handle_t} handle 串口句柄。
|
||||
* @param {uint32_t} timeout_ms 等待时间(ms)。
|
||||
* @param {uint32_t} timeout_ms 等待时间(毫秒)。
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
ret_t serial_wait_for_data(serial_handle_t handle, uint32_t timeout_ms);
|
||||
@ -332,8 +332,8 @@ bytesize_t serial_bytesize_from_str(const char* str);
|
||||
|
||||
/*不再使用 begin{*/
|
||||
typedef struct {
|
||||
uint32_t rd_timeout; /* 读超时时间(ms) */
|
||||
uint32_t rd_interval_timeout; /* 码间超时(ms) */
|
||||
uint32_t rd_timeout; /* 读超时时间(毫秒) */
|
||||
uint32_t rd_interval_timeout; /* 码间超时(毫秒) */
|
||||
} serial_timeout_t;
|
||||
ret_t serial_timeout_set(serial_handle_t handle, serial_timeout_t* timeout);
|
||||
ret_t serial_timeout_get(serial_handle_t handle, serial_timeout_t* timeout);
|
||||
|
@ -167,7 +167,7 @@ bool_t tk_socket_last_io_has_error(void);
|
||||
* 等待数据。
|
||||
*
|
||||
* @param {int} sock socket句柄。
|
||||
* @param {uint32_t} timeout_ms 等待时间(ms)。
|
||||
* @param {uint32_t} timeout_ms 等待时间(毫秒)。
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
ret_t tk_socket_wait_for_data(int sock, uint32_t timeout_ms);
|
||||
|
@ -30,7 +30,7 @@ BEGIN_C_DECLS
|
||||
* @class time_now_t
|
||||
* @annotation ["scriptable", "fake"]
|
||||
* 获取当前时间的函数。
|
||||
* 这里的当前时间是相对的,在嵌入式系统一般相对于开机时间。
|
||||
* 这里的当前时间是相对的,在嵌入式系统一般相对于开机时间(毫秒)。
|
||||
* 它本身并没有任何意义,一般用来计算时间间隔,如实现定时器和动画等等。
|
||||
*/
|
||||
|
||||
|
@ -103,7 +103,7 @@ ret_t timer_manager_destroy(timer_manager_t* timer_manager);
|
||||
* @param {timer_manager_t*} timer_manager 定时器管理器对象。
|
||||
* @param {timer_func_t} on_timer timer回调函数。
|
||||
* @param {void*} ctx timer回调函数的上下文。
|
||||
* @param {uint32_t} duration 时间。
|
||||
* @param {uint32_t} duration 时间(毫秒)。
|
||||
*
|
||||
* @return {uint32_t} 返回timer的ID,TK_INVALID_ID表示失败。
|
||||
*/
|
||||
@ -117,7 +117,7 @@ uint32_t timer_manager_add(timer_manager_t* timer_manager, timer_func_t on_timer
|
||||
* @param {uint32_t} id timer_id。
|
||||
* @param {timer_func_t} on_timer timer回调函数。
|
||||
* @param {void*} ctx timer回调函数的上下文。
|
||||
* @param {uint32_t} duration 时间。
|
||||
* @param {uint32_t} duration 时间(毫秒)。
|
||||
*
|
||||
* @return {uint32_t} 返回timer的ID,TK_INVALID_ID表示失败。
|
||||
*/
|
||||
@ -184,10 +184,10 @@ uint32_t timer_manager_count(timer_manager_t* timer_manager);
|
||||
|
||||
/**
|
||||
* @method timer_manager_next_time
|
||||
* 返回最近的定时器到期时间。
|
||||
* 返回最近的定时器到期时间(毫秒)。
|
||||
* @param {timer_manager_t*} timer_manager 定时器管理器对象。
|
||||
*
|
||||
* @return {uint64_t} 返回最近的timer到期时间。
|
||||
* @return {uint64_t} 返回最近的timer到期时间(毫秒)。
|
||||
*/
|
||||
uint64_t timer_manager_next_time(timer_manager_t* timer_manager);
|
||||
|
||||
@ -229,7 +229,7 @@ ret_t timer_manager_all_remove_by_ctx_and_type(timer_manager_t* timer_manager, u
|
||||
* @param {timer_manager_t*} timer_manager 定时器管理器对象。
|
||||
* @param {timer_func_t} on_timer 定时器回调函数。
|
||||
* @param {void*} ctx 上下文。
|
||||
* @param {uint32_t} duration 时间。
|
||||
* @param {uint32_t} duration 时间(毫秒)。
|
||||
* @param {uint16_t} timer_info_type timer_info_type。
|
||||
*
|
||||
* @return {uint32_t} 返回定时器id。
|
||||
@ -244,7 +244,7 @@ uint32_t timer_manager_add_with_type(timer_manager_t* timer_manager, timer_func_
|
||||
* @param {uint32_t} id id。
|
||||
* @param {timer_func_t} on_timer 定时器回调函数。
|
||||
* @param {void*} ctx 上下文。
|
||||
* @param {uint32_t} duration 时间。
|
||||
* @param {uint32_t} duration 时间(毫秒)。
|
||||
* @param {uint16_t} timer_info_type timer_info_type。
|
||||
* @param {bool_t} is_check_id 是否校验id。
|
||||
*
|
||||
|
@ -59,7 +59,7 @@ waitable_action_darray_t* waitable_action_darray_create(uint16_t capacity);
|
||||
*
|
||||
* @param {waitable_action_darray_t*} q waitable_action_darray对象。
|
||||
* @param {qaction_t**} action 用于返回action对象。
|
||||
* @param {uint32_t} timeout_ms 超时时间(ms)
|
||||
* @param {uint32_t} timeout_ms 超时时间(毫秒)
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
@ -72,7 +72,7 @@ ret_t waitable_action_darray_recv(waitable_action_darray_t* q, qaction_t** actio
|
||||
*
|
||||
* @param {waitable_action_darray_t*} q waitable_action_darray对象。
|
||||
* @param {qaction_t*} action action对象。
|
||||
* @param {uint32_t} timeout_ms 超时时间(ms)
|
||||
* @param {uint32_t} timeout_ms 超时时间(毫秒)
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
|
@ -57,7 +57,7 @@ waitable_action_queue_t* waitable_action_queue_create(uint16_t capacity);
|
||||
*
|
||||
* @param {waitable_action_queue_t*} q waitable_action_queue对象。
|
||||
* @param {qaction_t**} action 用于返回action对象。
|
||||
* @param {uint32_t} timeout_ms 超时时间(ms)
|
||||
* @param {uint32_t} timeout_ms 超时时间(毫秒)
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
@ -70,7 +70,7 @@ ret_t waitable_action_queue_recv(waitable_action_queue_t* q, qaction_t** action,
|
||||
*
|
||||
* @param {waitable_action_queue_t*} q waitable_action_queue对象。
|
||||
* @param {qaction_t*} action action对象。
|
||||
* @param {uint32_t} timeout_ms 超时时间(ms)
|
||||
* @param {uint32_t} timeout_ms 超时时间(毫秒)
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
|
@ -61,7 +61,7 @@ waitable_ring_buffer_t* waitable_ring_buffer_create(uint32_t capacity, uint32_t
|
||||
* @param {waitable_ring_buffer_t*} rb waitable_ring_buffer对象。
|
||||
* @param {void*} buff 接收数据的buff。
|
||||
* @param {uint32_t} size 读取数据的长度(必须等于 block_size)。
|
||||
* @param {uint32_t} timeout_ms 超时时间(ms)
|
||||
* @param {uint32_t} timeout_ms 超时时间(毫秒)
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
@ -75,7 +75,7 @@ ret_t waitable_ring_buffer_read(waitable_ring_buffer_t* rb, void* buff, uint32_t
|
||||
* @param {waitable_ring_buffer_t*} rb waitable_ring_buffer对象。
|
||||
* @param {const void*} buff 要写入的数据。
|
||||
* @param {uint32_t} size 数据的长度(必须等于 block_size)。
|
||||
* @param {uint32_t} timeout_ms 超时时间(ms)
|
||||
* @param {uint32_t} timeout_ms 超时时间(毫秒)
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
|
@ -42,8 +42,8 @@ typedef struct _widget_animator_prop_t {
|
||||
* @method widget_animator_prop_create
|
||||
* 创建单属性动画对象。
|
||||
* @param {widget_t*} widget 控件对象。
|
||||
* @param {uint32_t} duration 动画持续时间。
|
||||
* @param {uint32_t} delay 动画执行时间。
|
||||
* @param {uint32_t} duration 动画持续时间(毫秒)。
|
||||
* @param {uint32_t} delay 动画执行时间(毫秒)。
|
||||
* @param {easing_type_t} easing 插值函数类型。
|
||||
* @param {const char*} prop_name 属性的名称。
|
||||
*
|
||||
|
@ -45,8 +45,8 @@ typedef struct _widget_animator_prop2_t {
|
||||
* @method widget_animator_prop2_create
|
||||
* 创建双属性动画对象。
|
||||
* @param {widget_t*} widget 控件对象。
|
||||
* @param {uint32_t} duration 动画持续时间。
|
||||
* @param {uint32_t} delay 动画执行时间。
|
||||
* @param {uint32_t} duration 动画持续时间(毫秒)。
|
||||
* @param {uint32_t} delay 动画执行时间(毫秒)。
|
||||
* @param {easing_type_t} easing 插值函数类型。
|
||||
* @param {const char*} prop1_name 属性1的名称。
|
||||
* @param {const char*} prop2_name 属性2的名称。
|
||||
|
@ -44,8 +44,8 @@ typedef struct _widget_animator_scroll_t {
|
||||
* @method widget_animator_scroll_create
|
||||
* 创建动画对象。
|
||||
* @param {widget_t*} widget 控件对象。
|
||||
* @param {uint32_t} duration 动画持续时间。
|
||||
* @param {uint32_t} delay 动画执行时间。
|
||||
* @param {uint32_t} duration 动画持续时间(毫秒)。
|
||||
* @param {uint32_t} delay 动画执行时间(毫秒)。
|
||||
* @param {easing_type_t} easing 插值函数类型。
|
||||
*
|
||||
* @return {widget_animator_t*} 成功返回动画对象,失败返回NULL。
|
||||
|
@ -109,7 +109,7 @@ typedef struct _button_t {
|
||||
/**
|
||||
* @property {uint32_t} long_press_time
|
||||
* @annotation ["set_prop","get_prop","readable","persitent","design","scriptable"]
|
||||
* 触发长按事件的时间(ms)
|
||||
* 触发长按事件的时间(毫秒)
|
||||
*
|
||||
*/
|
||||
uint32_t long_press_time;
|
||||
@ -174,7 +174,7 @@ ret_t button_set_repeat(widget_t* widget, int32_t repeat);
|
||||
|
||||
/**
|
||||
* @method button_set_long_press_time
|
||||
* 设置触发长按事件的时间。
|
||||
* 设置触发长按事件的时间(毫秒)。
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget 控件对象。
|
||||
* @param {uint32_t} long_press_time 触发长按事件的时间(毫秒)。
|
||||
|
@ -97,7 +97,7 @@ typedef struct _popup_t {
|
||||
/**
|
||||
* @property {uint32_t} close_when_timeout
|
||||
* @annotation ["set_prop","get_prop","readable","persitent","design","scriptable"]
|
||||
* 超时后自动关闭窗口(ms)。
|
||||
* 超时后自动关闭窗口(毫秒)。
|
||||
*/
|
||||
uint32_t close_when_timeout;
|
||||
|
||||
@ -154,10 +154,10 @@ ret_t popup_set_close_when_click_outside(widget_t* widget, bool_t close_when_cli
|
||||
|
||||
/**
|
||||
* @method popup_set_close_when_timeout
|
||||
* 设置超时关闭时间(ms)。
|
||||
* 设置超时关闭时间(毫秒)。
|
||||
* @annotation ["scriptable"]
|
||||
* @param {widget_t*} widget 控件对象。
|
||||
* @param {uint32_t} close_when_timeout 大于0时,为定时器时间(ms),超时关闭窗口。
|
||||
* @param {uint32_t} close_when_timeout 大于0时,为定时器时间(毫秒),超时关闭窗口。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user