UP 按键扫描支持

lib/inc/task/task.h

@@ -29,36 +29,85 @@ struct TaskList {
     void *userdata;
 };
 
-//时间基准注册，建议1-10ms的基准
+/**
+ * @brief   初始化任务模块
+ * @param   TicksFunc: [输入] 时间基准函数指针
+ * @return  TaskStatus_t 返回任务状态
+ * @example TaskInit(GetPlatformTicks);
+ */
 TaskStatus_t TaskInit(PlatformTicksFunc_t TicksFunc);
 
-//创建任务
-//  time:间隔时间
-//  runcnt:执行次数 为-1无限制执行 为0只创建不运行
-//  callback:回调函数
-//  userdata:用户数据传参
+
+/**
+ * @brief   创建任务
+ * @param   task: [输入/输出] 任务结构体指针
+ * @param   time: [输入] 间隔时间
+ * @param   runcnt: [输入] 执行次数，-1为无限制执行，0为只创建不运行
+ * @param   callback: [输入] 回调函数
+ * @param   userdata: [输入] 用户数据传参
+ * @return  TaskStatus_t 返回任务状态
+ * @example TaskCreat(&myTask, 100, -1, myCallbackFunc, &myData);
+ */
 TaskStatus_t TaskCreat(Task_t *task, TaskTime_t time, TaskCnt_t runcnt, Task_Callback_t callback, void *userdata);
 
-//添加任务
+/**
+ * @brief   添加任务
+ * @param   task: [输入] 任务结构体指针
+ * @return  TaskStatus_t 返回任务状态
+ * @example TaskAdd(&myTask);
+ */
 TaskStatus_t TaskAdd(Task_t *task);
 
-//删除任务
+/**
+ * @brief   删除任务
+ * @param   task: [输入] 任务结构体指针
+ * @return  TaskStatus_t 返回任务状态
+ * @example TaskDel(&myTask);
+ */
 TaskStatus_t TaskDel(Task_t *task);
 
-//重新开始以停止的任务
+/**
+ * @brief   重新开始停止的任务
+ * @param   task: [输入] 任务结构体指针
+ * @return  TaskStatus_t 返回任务状态
+ * @example TaskStart(&myTask);
+ */
 TaskStatus_t TaskStart(Task_t *task);
 
-//暂停任务执行
+/**
+ * @brief   暂停任务执行
+ * @param   task: [输入] 任务结构体指针
+ * @return  TaskStatus_t 返回任务状态
+ * @example TaskStop(&myTask);
+ */
 TaskStatus_t TaskStop(Task_t *task);
 
-//重设任务执行次数
+/**
+ * @brief   重设任务执行次数
+ * @param   task: [输入] 任务结构体指针
+ * @param   runcnt: [输入] 新的执行次数
+ * @return  TaskStatus_t 返回任务状态
+ * @example TaskSetCnt(&myTask, 5);
+ */
 TaskStatus_t TaskSetCnt(Task_t *task, TaskCnt_t runcnt);
 
-//重设任务间隔时间
+/**
+ * @brief   重设任务间隔时间
+ * @param   task: [输入] 任务结构体指针
+ * @param   time: [输入] 新的间隔时间
+ * @return  TaskStatus_t 返回任务状态
+ * @example TaskSetTime(&myTask, 50);
+ */
+
 TaskStatus_t TaskSetTime(Task_t *task, TaskTime_t time);
 
-//任务调度
+/**
+ * @brief   任务调度
+ * @return  TaskStatus_t 返回任务状态
+ * @example TaskRun();
+ */
 TaskStatus_t TaskRun(void);
+
 #ifdef __cplusplus
 }
 #endif