From 2d4ce2d0f9d613c39cba33abd3d67289bf16711d Mon Sep 17 00:00:00 2001
From: lixianjing <xianjimli@hotmail.com>
Date: Fri, 21 Apr 2023 11:34:00 +0800
Subject: [PATCH] improve api docs

---
 docs/changes.md              | 1 +
 src/tkc/action_thread_pool.h | 4 ++--
 src/tkc/async.h              | 4 ++--
 3 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/docs/changes.md b/docs/changes.md
index 04580e5f8..ddc7adf37 100644
--- a/docs/changes.md
+++ b/docs/changes.md
@@ -2,6 +2,7 @@
 
 2023/04/21
   * 完善action thread pool(感谢俊杰提供补丁)
+  * 完善文档注释(感谢俊杰提供补丁)
 
 2023/04/19
   * 新增is\_horizon属性判断(感谢高源提供补丁)
diff --git a/src/tkc/action_thread_pool.h b/src/tkc/action_thread_pool.h
index 001404e7b..ade5b2e69 100644
--- a/src/tkc/action_thread_pool.h
+++ b/src/tkc/action_thread_pool.h
@@ -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 优先级
  *
diff --git a/src/tkc/async.h b/src/tkc/async.h
index 93bc47706..cd8125e80 100644
--- a/src/tkc/async.h
+++ b/src/tkc/async.h
@@ -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表示成功，否则表示失败。