Skip to content

Commit

Permalink
sync docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xianjimli committed Dec 26, 2023
1 parent 98722fb commit eda88c1
Show file tree
Hide file tree
Showing 66 changed files with 4,108 additions and 207 deletions.
32 changes: 32 additions & 0 deletions docs/manual/action_darray_thread_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
| <a href="#action_darray_thread_t_action_darray_thread_create_with_darray_ex">action\_darray\_thread\_create\_with\_darray\_ex</a> | 创建action_darray_thread对象。 |
| <a href="#action_darray_thread_t_action_darray_thread_destroy">action\_darray\_thread\_destroy</a> | 销毁。 |
| <a href="#action_darray_thread_t_action_darray_thread_exec">action\_darray\_thread\_exec</a> | 让线程执行action。 |
| <a href="#action_darray_thread_t_action_darray_thread_set_idle_interval">action\_darray\_thread\_set\_idle\_interval</a> | 设置空闲时的时间间隔。 |
| <a href="#action_darray_thread_t_action_darray_thread_set_on_idle">action\_darray\_thread\_set\_on\_idle</a> | 设置空闲时的回调函数。 |
| <a href="#action_darray_thread_t_action_darray_thread_set_on_quit">action\_darray\_thread\_set\_on\_quit</a> | 设置退出时的回调函数。 |
| <a href="#action_darray_thread_t_action_darray_thread_set_strategy">action\_darray\_thread\_set\_strategy</a> | 设置策略 |
Expand All @@ -29,6 +30,7 @@
| -------- | ----- | ------------ |
| <a href="#action_darray_thread_t_darray">darray</a> | waitable\_action\_darray\_t* | action darray。 |
| <a href="#action_darray_thread_t_executed_actions_nr">executed\_actions\_nr</a> | uint32\_t | 已经执行action的个数。 |
| <a href="#action_darray_thread_t_idle_interval">idle\_interval</a> | uint32\_t | 空闲时的时间间隔。 |
| <a href="#action_darray_thread_t_thread">thread</a> | tk\_thread\_t* | 线程对象。 |
#### action\_darray\_thread\_create 函数
-----------------------
Expand Down Expand Up @@ -149,6 +151,26 @@ ret_t action_darray_thread_exec (action_darray_thread_t* thread, qaction_t* acti
| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 |
| thread | action\_darray\_thread\_t* | action\_darray\_thread对象。 |
| action | qaction\_t* | action对象。 |
#### action\_darray\_thread\_set\_idle\_interval 函数
-----------------------

* 函数功能:

> <p id="action_darray_thread_t_action_darray_thread_set_idle_interval">设置空闲时的时间间隔。
* 函数原型:

```
ret_t action_darray_thread_set_idle_interval (action_darray_thread_t* thread, uint32_t interval);
```

* 参数说明:

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 |
| thread | action\_darray\_thread\_t* | action\_darray\_thread对象。 |
| interval | uint32\_t | 时间间隔(ms)。 |
#### action\_darray\_thread\_set\_on\_idle 函数
-----------------------

Expand Down Expand Up @@ -305,6 +327,16 @@ ret_t action_queue_send (action_queue_t* q, qaction_t* action);
* 类型:uint32\_t

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 ||
| 可直接修改 ||
#### idle\_interval 属性
-----------------------
> <p id="action_darray_thread_t_idle_interval">空闲时的时间间隔。
* 类型:uint32\_t

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 ||
Expand Down
21 changes: 21 additions & 0 deletions docs/manual/assets_manager_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ ui UI描述数据。
| <a href="#assets_manager_t_assets_manager_create">assets\_manager\_create</a> | 创建资源管理器。 |
| <a href="#assets_manager_t_assets_manager_deinit">assets\_manager\_deinit</a> | 释放全部资源。 |
| <a href="#assets_manager_t_assets_manager_destroy">assets\_manager\_destroy</a> | 释放全部资源并销毁asset manager对象。 |
| <a href="#assets_manager_t_assets_manager_dump">assets\_manager\_dump</a> | 输出资源管理器的信息。 |
| <a href="#assets_manager_t_assets_manager_find_in_cache">assets\_manager\_find\_in\_cache</a> | 在资源管理器的缓存中查找指定的资源(不引用)。 |
| <a href="#assets_manager_t_assets_manager_get_res_root">assets\_manager\_get\_res\_root</a> | 获取资源所在的目录(其下目录结构请参考demos)。 |
| <a href="#assets_manager_t_assets_manager_init">assets\_manager\_init</a> | 初始化资源管理器。 |
Expand Down Expand Up @@ -274,6 +275,26 @@ ret_t assets_manager_destroy (assets_manager_t* am);
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 |
| am | assets\_manager\_t* | asset manager对象。 |
#### assets\_manager\_dump 函数
-----------------------

* 函数功能:

> <p id="assets_manager_t_assets_manager_dump">输出资源管理器的信息。
* 函数原型:

```
ret_t assets_manager_dump (assets_manager_t* am, str_t* result);
```

* 参数说明:

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 |
| am | assets\_manager\_t* | asset manager对象。 |
| result | str\_t* | 输出的字符串。 |
#### assets\_manager\_find\_in\_cache 函数
-----------------------

Expand Down
19 changes: 19 additions & 0 deletions docs/manual/combo_box_ex_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#combo_box_ex_t_combo_box_ex_create">combo\_box\_ex\_create</a> | 创建combo_box_ex对象 |
| <a href="#combo_box_ex_t_combo_box_ex_get_widget_vtable">combo\_box\_ex\_get\_widget\_vtable</a> | 获取 combo_box_ex 虚表。 |
#### combo\_box\_ex\_create 函数
-----------------------

Expand All @@ -36,3 +37,21 @@ widget_t* combo_box_ex_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h)
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
#### combo\_box\_ex\_get\_widget\_vtable 函数
-----------------------

* 函数功能:

> <p id="combo_box_ex_t_combo_box_ex_get_widget_vtable">获取 combo_box_ex 虚表。
* 函数原型:

```
const widget_vtable_t* combo_box_ex_get_widget_vtable ();
```

* 参数说明:

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | const widget\_vtable\_t* | 成功返回 combo\_box\_ex 虚表。 |
16 changes: 8 additions & 8 deletions docs/manual/crc_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ crc相关函数。
* 函数原型:

```
uint16_t tk_chksum (uint16_t sum, const uint8_t* data, int size);
uint16_t tk_chksum (uint16_t sum, const void* data, int size);
```

* 参数说明:
Expand All @@ -34,7 +34,7 @@ uint16_t tk_chksum (uint16_t sum, const uint8_t* data, int size);
| -------- | ----- | --------- |
| 返回值 | uint16\_t | 返回计算结果。 |
| sum | uint16\_t | 初始值(一般用INITCHECKSUM) |
| data | const uint8\_t* | 数据。 |
| data | const void* | 数据。 |
| size | int | 数据长度。 |
#### tk\_chksum\_byte 函数
-----------------------
Expand Down Expand Up @@ -66,7 +66,7 @@ uint16_t tk_chksum_byte (uint16_t sum, uint8_t data);
* 函数原型:

```
uint16_t tk_crc16 (uint16_t crc, const uint8_t* data, int size);
uint16_t tk_crc16 (uint16_t crc, const void* data, int size);
```

* 参数说明:
Expand All @@ -75,7 +75,7 @@ uint16_t tk_crc16 (uint16_t crc, const uint8_t* data, int size);
| -------- | ----- | --------- |
| 返回值 | uint16\_t | 返回计算结果。 |
| crc | uint16\_t | 初始值(一般用PPPINITFCS16) |
| data | const uint8\_t* | 数据。 |
| data | const void* | 数据。 |
| size | int | 数据长度。 |
#### tk\_crc16\_byte 函数
-----------------------
Expand Down Expand Up @@ -107,15 +107,15 @@ uint16_t tk_crc16_byte (uint16_t crc, uint8_t data);
* 函数原型:

```
uint16_t tk_crc16_modbus (const uint8_t* data, int size);
uint16_t tk_crc16_modbus (const void* data, int size);
```

* 参数说明:

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint16\_t | 返回计算结果。 |
| data | const uint8\_t* | 数据。 |
| data | const void* | 数据。 |
| size | int | 数据长度。 |
#### tk\_crc32 函数
-----------------------
Expand All @@ -127,7 +127,7 @@ uint16_t tk_crc16_modbus (const uint8_t* data, int size);
* 函数原型:

```
uint32_t tk_crc32 (uint32_t crc, const uint8_t* data, int size);
uint32_t tk_crc32 (uint32_t crc, const void* data, int size);
```

* 参数说明:
Expand All @@ -136,7 +136,7 @@ uint32_t tk_crc32 (uint32_t crc, const uint8_t* data, int size);
| -------- | ----- | --------- |
| 返回值 | uint32\_t | 返回计算结果。 |
| crc | uint32\_t | 初始值(一般用PPPINITFCS32) |
| data | const uint8\_t* | 数据。 |
| data | const void* | 数据。 |
| size | int | 数据长度。 |
#### tk\_crc32\_byte 函数
-----------------------
Expand Down
107 changes: 107 additions & 0 deletions docs/manual/csv_file_object_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,36 @@ TK_OBJECT_UNREF(csv);
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#csv_file_object_t_csv_file_object_cast">csv\_file\_object\_cast</a> | 转换为csv_file_object_t。 |
| <a href="#csv_file_object_t_csv_file_object_create">csv\_file\_object\_create</a> | 将csv_file对象包装成object。 |
| <a href="#csv_file_object_t_csv_file_object_find_first">csv\_file\_object\_find\_first</a> | 查找第一个满足条件的行。 |
| <a href="#csv_file_object_t_csv_file_object_get_csv">csv\_file\_object\_get\_csv</a> | 获取csv对象。 |
| <a href="#csv_file_object_t_csv_file_object_load">csv\_file\_object\_load</a> | 从指定文件加载CSV对象。 |
| <a href="#csv_file_object_t_csv_file_object_load_from_buff">csv\_file\_object\_load\_from\_buff</a> | 从内存加载CSV对象。 |
| <a href="#csv_file_object_t_csv_file_object_parse_col">csv\_file\_object\_parse\_col</a> | 解析列名。 |
| <a href="#csv_file_object_t_csv_file_object_save_as">csv\_file\_object\_save\_as</a> | 将doc对象保存到指定文件。 |
| <a href="#csv_file_object_t_csv_file_object_save_to_buff">csv\_file\_object\_save\_to\_buff</a> | 将obj保存为CSV格式到内存。 |
| <a href="#csv_file_object_t_csv_file_object_set_check_new_row">csv\_file\_object\_set\_check\_new\_row</a> | 设置检查新行的回调。 |
| <a href="#csv_file_object_t_csv_file_object_set_filter">csv\_file\_object\_set\_filter</a> | 设置过滤器。 |
#### csv\_file\_object\_cast 函数
-----------------------
* 函数功能:
> <p id="csv_file_object_t_csv_file_object_cast">转换为csv_file_object_t。
* 函数原型:
```
csv_file_object_t* csv_file_object_cast (tk_object_t* obj);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | csv\_file\_object\_t* | 返回csv\_file\_object\_t对象。 |
| obj | tk\_object\_t* | doc对象。 |
#### csv\_file\_object\_create 函数
-----------------------
Expand All @@ -85,6 +109,27 @@ tk_object_t* csv_file_object_create (csv_file_t* csv);
| -------- | ----- | --------- |
| 返回值 | tk\_object\_t* | 返回对象。 |
| csv | csv\_file\_t* | csv对象(由object释放)。 |
#### csv\_file\_object\_find\_first 函数
-----------------------
* 函数功能:
> <p id="csv_file_object_t_csv_file_object_find_first">查找第一个满足条件的行。
* 函数原型:
```
csv_row_t* csv_file_object_find_first (tk_object_t* obj, tk_compare_t compare, void* ctx);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | csv\_row\_t* | 返回行对象。 |
| obj | tk\_object\_t* | doc对象。 |
| compare | tk\_compare\_t | 比较函数。 |
| ctx | void* | 上下文。 |
#### csv\_file\_object\_get\_csv 函数
-----------------------
Expand Down Expand Up @@ -145,6 +190,26 @@ tk_object_t* csv_file_object_load_from_buff (const void* buff, uint32_t size, ch
| buff | const void* | 数据。 |
| size | uint32\_t | 数据长度。 |
| sep | char | 分隔符。 |
#### csv\_file\_object\_parse\_col 函数
-----------------------
* 函数功能:
> <p id="csv_file_object_t_csv_file_object_parse_col">解析列名。
* 函数原型:
```
int32_t csv_file_object_parse_col (csv_file_object_t* o, const char* name);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回列索引。 |
| o | csv\_file\_object\_t* | csv\_file\_object\_t对象。 |
| name | const char* | 列名。 |
#### csv\_file\_object\_save\_as 函数
-----------------------
Expand Down Expand Up @@ -185,3 +250,45 @@ ret_t csv_file_object_save_to_buff (tk_object_t* obj, wbuffer_t* wb);
| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败 |
| obj | tk\_object\_t* | doc对象。 |
| wb | wbuffer\_t* | 返回结果(不要初始化,使用完成后要调用wbuffer\_deinit)。 |
#### csv\_file\_object\_set\_check\_new\_row 函数
-----------------------
* 函数功能:
> <p id="csv_file_object_t_csv_file_object_set_check_new_row">设置检查新行的回调。
* 函数原型:
```
ret_t csv_file_object_set_check_new_row (tk_object_t* obj, csv_filter_object_check_new_row_t check_new_row, void* ctx);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败 |
| obj | tk\_object\_t* | doc对象。 |
| check\_new\_row | csv\_filter\_object\_check\_new\_row\_t | 检查新行的回调。 |
| ctx | void* | 上下文。 |
#### csv\_file\_object\_set\_filter 函数
-----------------------
* 函数功能:
> <p id="csv_file_object_t_csv_file_object_set_filter">设置过滤器。
* 函数原型:
```
ret_t csv_file_object_set_filter (tk_object_t* obj, csv_file_object_filter_t filter, void* ctx);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败 |
| obj | tk\_object\_t* | doc对象。 |
| filter | csv\_file\_object\_filter\_t | 过滤器。 |
| ctx | void* | 上下文。 |
Loading

0 comments on commit eda88c1

Please sign in to comment.