improve api comment

This commit is contained in:
lixianjing 2020-10-10 12:23:39 +08:00
parent 0bf68d669a
commit 95a671fc65
5 changed files with 29 additions and 9 deletions

View File

@ -729,6 +729,7 @@ EXPORTS
widget_is_normal_window
widget_is_dialog
widget_is_popup
widget_is_overlay
widget_is_opened_popup
widget_is_keyboard
widget_is_designing_window

View File

@ -2,7 +2,8 @@
2020/10/10
* window_manager_back 支持 overlay 和 popup。
* 完善 API 注释(感谢兆坤提供补丁)。
2020/10/09
* 把 grab\_focus 和 return\_key\_to\_grab\_focus 属性移到 title\_value 自定义控件。

View File

@ -286,7 +286,7 @@ ret_t dialog_set_title(widget_t* widget, const char* title);
* @annotation ["scriptable"]
* @param {widget_t*} widget dialog对象
*
* @return {dialog_quit_code_t} 退
* @return {dialog_quit_code_t} 退
*/
dialog_quit_code_t dialog_modal(widget_t* widget);

View File

@ -130,7 +130,7 @@ typedef struct _im_commit_event_t {
const char* text;
/**
* @property {bool_t} replace;
* @property {bool_t} replace
* @annotation ["readable"]
*
*/
@ -192,9 +192,9 @@ typedef struct _im_candidates_event_t {
uint32_t candidates_nr;
/**
* @property {int32_t} selected;
* @property {int32_t} selected
* @annotation ["readable"]
* 0
* 0
*/
int32_t selected;
} im_candidates_event_t;

View File

@ -21086,6 +21086,24 @@
"desc": "返回FALSE表示不是否则表示是。"
}
},
{
"params": [
{
"type": "widget_t*",
"name": "widget",
"desc": "widget对象。"
}
],
"annotation": {
"scriptable": true
},
"desc": "检查控件是否是overlay窗口类型。",
"name": "widget_is_overlay",
"return": {
"type": "bool_t",
"desc": "返回FALSE表示不是否则表示是。"
}
},
{
"params": [
{
@ -57295,7 +57313,7 @@
}
},
{
"name": "replace;",
"name": "replace",
"desc": "是否替换原来的文本。",
"type": "bool_t",
"annotation": {
@ -57739,8 +57757,8 @@
}
},
{
"name": "selected;",
"desc": "缺省选中某个候选字,小余0不选择任何候选字 。",
"name": "selected",
"desc": "缺省选中某个候选字,小于0不选择任何候选字。",
"type": "int32_t",
"annotation": {
"readable": true
@ -61812,7 +61830,7 @@
"name": "dialog_modal",
"return": {
"type": "dialog_quit_code_t",
"desc": "返回退出。"
"desc": "返回退出。"
}
},
{