aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYuji Mano <yuji.mano@am.sony.com>2009-03-26 17:32:56 -0700
committerYuji Mano <yuji.mano@am.sony.com>2009-03-26 17:32:56 -0700
commit23c72f3195573697275618bdd8da484f5bb8bfe5 (patch)
tree3de70ae3a92cb4bc0876b16c1683ea47e450084a
parent48a72cc6c514ce6f46a028c6aa342552ab3487a3 (diff)
downloadmars-src-23c72f3195573697275618bdd8da484f5bb8bfe5.tar.gz
doxygen: Update documentation
-rw-r--r--doxygen/src/doxygen9
-rw-r--r--task/include/mpu/mars/task.h2
2 files changed, 6 insertions, 5 deletions
diff --git a/doxygen/src/doxygen b/doxygen/src/doxygen
index ae85c18..1e6c720 100644
--- a/doxygen/src/doxygen
+++ b/doxygen/src/doxygen
@@ -4301,13 +4301,12 @@ This section will describe the MARS API.
- Workload Model Management
- \ref mars_workload_queue_add_begin
- \ref mars_workload_queue_add_end
- - \ref mars_workload_queue_add_cancel
- \ref mars_workload_queue_remove_begin
- \ref mars_workload_queue_remove_end
- - \ref mars_workload_queue_remove_cancel
- \ref mars_workload_queue_schedule_begin
- \ref mars_workload_queue_schedule_end
- - \ref mars_workload_queue_schedule_cancel
+ - \ref mars_workload_queue_unschedule_begin
+ - \ref mars_workload_queue_unschedule_end
- \ref mars_workload_queue_wait
- \ref mars_workload_queue_try_wait
- \ref mars_workload_queue_signal_send
@@ -4362,7 +4361,8 @@ This section will describe the MARS API.
- \ref mars_module_workload_signal_reset
- \ref mars_module_workload_schedule_begin
- \ref mars_module_workload_schedule_end
- - \ref mars_module_workload_schedule_cancel
+ - \ref mars_module_workload_unschedule_begin
+ - \ref mars_module_workload_unschedule_end
- \ref mars_module_workload_wait
- \ref mars_module_workload_yield
- \ref mars_module_workload_finish
@@ -4379,6 +4379,7 @@ This section will describe the MARS API.
- \ref mars_task_exit
- \ref mars_task_yield
- \ref mars_task_schedule
+ - \ref mars_task_unschedule
- \ref mars_task_wait
- \ref mars_task_try_wait
- \ref mars_task_call_host
diff --git a/task/include/mpu/mars/task.h b/task/include/mpu/mars/task.h
index 118c638..fb0c90b 100644
--- a/task/include/mpu/mars/task.h
+++ b/task/include/mpu/mars/task.h
@@ -184,7 +184,7 @@ int mars_task_schedule(const struct mars_task_id *id,
*
* If the task is currently in a running state, calling unschedule will
* immediately put the task into a finished state. However, execution of the
- * task will only be suspended when the workload yields, waits, or finishes.
+ * task will only be suspended when the task yields, waits, or exits.
*
* \note
* Trying to unschedule a task that has not yet been scheduled, or has