improve api docs

This commit is contained in:
lixianjing 2023-04-21 11:34:00 +08:00
parent e069232806
commit 2d4ce2d0f9
3 changed files with 5 additions and 4 deletions

View File

@ -2,6 +2,7 @@
2023/04/21
* 完善action thread pool(感谢俊杰提供补丁)
* 完善文档注释(感谢俊杰提供补丁)
2023/04/19
* 新增is\_horizon属性判断(感谢高源提供补丁)

View File

@ -71,7 +71,7 @@ typedef struct _action_thread_pool_t {
* action_thread_pool对象
*
* @param {uint16_t} max_thread_nr 线
* @param {uint16_t} min_idle_nr 线
* @param {uint16_t} min_idle_nr 线(0)
*
* @return {action_thread_pool_t*} action_thread_pool对象
*/
@ -83,7 +83,7 @@ action_thread_pool_t* action_thread_pool_create(uint16_t max_thread_nr, uint16_t
* action_thread_pool对象
*
* @param {uint16_t} max_thread_nr 线
* @param {uint16_t} min_idle_nr 线
* @param {uint16_t} min_idle_nr 线(0)
* @param {uint32_t} stack_size
* @param {tk_thread_priority_t} priority
*

View File

@ -58,7 +58,7 @@ ret_t async_call(async_exec_t exec, async_on_result_t on_result, void* ctx);
*
* @annotation ["static"]
* @param {uint32_t} max_threads 线
* @param {uint32_t} min_threads 线
* @param {uint32_t} min_threads 线(0)
*
* @return {ret_t} RET_OK表示成功
*
@ -71,7 +71,7 @@ ret_t async_call_init_ex(uint32_t max_threads, uint32_t min_threads);
*
* @annotation ["static"]
* @param {uint32_t} max_threads 线
* @param {uint32_t} min_threads 线
* @param {uint32_t} min_threads 线(0)
* @param {uint32_t} stack_size ()
*
* @return {ret_t} RET_OK表示成功