diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-05 18:16:48 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2012-12-05 18:16:48 -0500 |
| commit | a6500136a9f30603f7dff766d7b98766851c7204 (patch) | |
| tree | 852061b300cada7facff9025868b143565058dc2 /cpukit/rtems/include/rtems/rtems/sem.h | |
| parent | rtems misc: Clean up Doxygen GCI Task #6 (diff) | |
| download | rtems-a6500136a9f30603f7dff766d7b98766851c7204.tar.bz2 | |
rtems misc: Clean up Doxygen GCI Task #7
http://www.google-melange.com/gci/task/view/google/gci2012/7950206
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/sem.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h index aedc5ea961..4fcf93e94c 100644 --- a/cpukit/rtems/include/rtems/rtems/sem.h +++ b/cpukit/rtems/include/rtems/rtems/sem.h @@ -168,7 +168,7 @@ rtems_status_code rtems_semaphore_delete( ); /** - * @brief rtems_semaphore_obtain + * @brief RTEMS Obtain Semaphore * * This routine implements the rtems_semaphore_obtain directive. It * attempts to obtain a unit from the semaphore associated with ID. @@ -177,6 +177,14 @@ rtems_status_code rtems_semaphore_delete( * block waiting for a unit with an optional timeout of timeout * clock ticks. Whether the task blocks or returns immediately * is based on the RTEMS_NO_WAIT option in the option_set. + * + * @param[in] id is the semaphore id + * @param[in] option_set is the wait option + * @param[in] timeout is the number of ticks to wait (0 means wait forever) + * + * @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_semaphore_obtain( rtems_id id, |