diff options
| author | Mathew Kallada <matkallada@gmail.com> | 2012-12-02 16:59:17 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-12-02 16:59:17 -0600 |
| commit | c05d75020d231aa193444a84c84d5ecaa1a4cefa (patch) | |
| tree | 9c536c3693cdeb925364d06235918f993e2b9d9f /cpukit/rtems/include/rtems/rtems/tasks.h | |
| parent | score misc: Clean up Doxygen #13 (GCI 2012) (diff) | |
| download | rtems-c05d75020d231aa193444a84c84d5ecaa1a4cefa.tar.bz2 | |
score misc: Clean up Doxygen #14 (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.
http://www.google-melange.com/gci/task/view/google/gci2012/8025204
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/tasks.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h index e80df03103..b6b1c1c5b2 100644 --- a/cpukit/rtems/include/rtems/rtems/tasks.h +++ b/cpukit/rtems/include/rtems/rtems/tasks.h @@ -375,12 +375,19 @@ rtems_status_code rtems_task_resume( ); /** - * @brief rtems_task_set_priority + * @brief RTEMS Set Task Priority * * This routine implements the rtems_task_set_priority directive. The * current priority of the task associated with ID is set to * new_priority. The former priority of that task is returned * in old_priority. + * + * @param[in] id is the thread to extract + * @param[in] new_priority is the thread to extract + * @param[in] old_priority is the thread to extract + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and + * and *old_priority filled in with the previous previous priority */ rtems_status_code rtems_task_set_priority( rtems_id id, |