summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/tasks.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-04 17:59:11 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-04 17:59:11 -0500
commitc18e0ba12799ea40693428b0a731bb561e61cab0 (patch)
tree20e76592df6ad8f0ae2efb5c27f0b6870a33086e /cpukit/rtems/include/rtems/rtems/tasks.h
parentcpukit: Clean up Doxygen #3 (GCI 2012) (diff)
downloadrtems-c18e0ba12799ea40693428b0a731bb561e61cab0.tar.bz2
rtems misc: Clean up Doxygen GCI Task #4
http://www.google-melange.com/gci/task/view/google/gci2012/7950205
Diffstat (limited to '')
-rw-r--r--cpukit/rtems/include/rtems/rtems/tasks.h18
1 files changed, 16 insertions, 2 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h
index 03795d5e37..90379c17d2 100644
--- a/cpukit/rtems/include/rtems/rtems/tasks.h
+++ b/cpukit/rtems/include/rtems/rtems/tasks.h
@@ -324,11 +324,19 @@ rtems_status_code rtems_task_get_note(
);
/**
- * @brief rtems_task_set_note
+ * @brief RTEMS Set Task Note
*
* This routine implements the rtems_task_set_note directive. The
* value of the indicated notepad for the task associated with ID
* is returned in note.
+ *
+ * @param[in] id is the thread id
+ * @param[in] notepad is the notepad number
+ * @param[in] note is the note value
+ *
+ * @return This method returns RTEMS_SUCCESSFUL if there was not an
+ * error. Otherwise, a status code is returned indicating the
+ * source of the error.
*/
rtems_status_code rtems_task_set_note(
rtems_id id,
@@ -378,10 +386,16 @@ rtems_status_code rtems_task_suspend(
);
/**
- * @brief rtems_task_resume
+ * @brief RTEMS Resume Task
*
* This routine implements the rtems_task_resume Directive. The
* SUSPENDED state is cleared for task associated with ID.
+ *
+ * @param[in] id is the thread id
+ *
+ * @return This method returns RTEMS_SUCCESSFUL if there was not an
+ * error. Otherwise, a status code is returned indicating the
+ * source of the error.
*/
rtems_status_code rtems_task_resume(
rtems_id id