update docs

This commit is contained in:
lixianjing 2021-08-03 09:13:24 +08:00
parent 18fcc1e0b0
commit 4a8a60ca84
2 changed files with 12 additions and 12 deletions

View File

@ -8,7 +8,7 @@ action线程池。
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#action_thread_pool_t_action_thread_pool_create">action\_thread\_pool\_create</a> | 创建action_thread_pool对象。 |
| <a href="#action_thread_pool_t_action_thread_pool_create">action\_thread\_pool\_create</a> | 创建action_thread_pool对象。 |
| <a href="#action_thread_pool_t_action_thread_pool_create_ex">action\_thread\_pool\_create\_ex</a> | 创建action_thread_pool对象。 |
| <a href="#action_thread_pool_t_action_thread_pool_destroy">action\_thread\_pool\_destroy</a> | 销毁。 |
| <a href="#action_thread_pool_t_action_thread_pool_exec">action\_thread\_pool\_exec</a> | 执行action。 |
### 属性
@ -40,17 +40,17 @@ action_thread_pool_t* action_thread_pool_create (uint16_t max_thread_nr, uint16_
| 返回值 | action\_thread\_pool\_t* | action\_thread\_pool对象。 |
| max\_thread\_nr | uint16\_t | 最大线程数。 |
| min\_idle\_nr | uint16\_t | 最小空闲线程数。 |
#### action\_thread\_pool\_create 函数
#### action\_thread\_pool\_create\_ex 函数
-----------------------
* 函数功能:
> <p id="action_thread_pool_t_action_thread_pool_create">创建action_thread_pool对象。
> <p id="action_thread_pool_t_action_thread_pool_create_ex">创建action_thread_pool对象。
* 函数原型:
```
action_thread_pool_t* action_thread_pool_create (uint16_t max_thread_nr, uint16_t min_idle_nr, uint32_t stack_size, tk_thread_priority_t priority);
action_thread_pool_t* action_thread_pool_create_ex (uint16_t max_thread_nr, uint16_t min_idle_nr, uint32_t stack_size, tk_thread_priority_t priority);
```
* 参数说明:

View File

@ -10,9 +10,9 @@
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#action_thread_t_action_thread_create">action\_thread\_create</a> | 创建action_thread对象。 |
| <a href="#action_thread_t_action_thread_create">action\_thread\_create</a> | 创建action_thread对象。 |
| <a href="#action_thread_t_action_thread_create_with_queue">action\_thread\_create\_with\_queue</a> | 创建action_thread对象。 |
| <a href="#action_thread_t_action_thread_create_ex">action\_thread\_create\_ex</a> | 创建action_thread对象。 |
| <a href="#action_thread_t_action_thread_create_with_queue">action\_thread\_create\_with\_queue</a> | 创建action_thread对象。 |
| <a href="#action_thread_t_action_thread_create_with_queue_ex">action\_thread\_create\_with\_queue\_ex</a> | 创建action_thread对象。 |
| <a href="#action_thread_t_action_thread_destroy">action\_thread\_destroy</a> | 销毁。 |
| <a href="#action_thread_t_action_thread_exec">action\_thread\_exec</a> | 让线程执行action。 |
| <a href="#action_thread_t_action_thread_set_on_idle">action\_thread\_set\_on\_idle</a> | 设置空闲时的回调函数。 |
@ -43,17 +43,17 @@ action_thread_t* action_thread_create ();
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | action\_thread\_t* | action\_thread对象。 |
#### action\_thread\_create 函数
#### action\_thread\_create\_ex 函数
-----------------------
* 函数功能:
> <p id="action_thread_t_action_thread_create">创建action_thread对象。
> <p id="action_thread_t_action_thread_create_ex">创建action_thread对象。
* 函数原型:
```
action_thread_t* action_thread_create (const char* name, uint32_t stack_size, tk_thread_priority_t priority);
action_thread_t* action_thread_create_ex (const char* name, uint32_t stack_size, tk_thread_priority_t priority);
```
* 参数说明:
@ -83,17 +83,17 @@ action_thread_t* action_thread_create_with_queue (waitable_action_queue_t* queue
| -------- | ----- | --------- |
| 返回值 | action\_thread\_t* | action\_thread对象。 |
| queue | waitable\_action\_queue\_t* | queue对象。 |
#### action\_thread\_create\_with\_queue 函数
#### action\_thread\_create\_with\_queue\_ex 函数
-----------------------
* 函数功能:
> <p id="action_thread_t_action_thread_create_with_queue">创建action_thread对象。
> <p id="action_thread_t_action_thread_create_with_queue_ex">创建action_thread对象。
* 函数原型:
```
action_thread_t* action_thread_create_with_queue (waitable_action_queue_t* queue, const char* name, uint32_t stack_size, tk_thread_priority_t priority);
action_thread_t* action_thread_create_with_queue_ex (waitable_action_queue_t* queue, const char* name, uint32_t stack_size, tk_thread_priority_t priority);
```
* 参数说明: