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/sem.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/sem.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h index 4475d030c2..a75ef4130a 100644 --- a/cpukit/rtems/include/rtems/rtems/sem.h +++ b/cpukit/rtems/include/rtems/rtems/sem.h @@ -128,7 +128,7 @@ rtems_status_code rtems_semaphore_create( ); /** - * @brief rtems_semaphore_ident + * @brief RTEMS Semaphore Name to Id * * This routine implements the rtems_semaphore_ident directive. * This directive returns the semaphore ID associated with name. @@ -137,6 +137,13 @@ rtems_status_code rtems_semaphore_create( * extent of the search for the ID of the semaphore named name. * The search can be limited to a particular node or allowed to * encompass all nodes. + * + * @param[in] name is the user defined semaphore name + * @param[in] node is(are) the node(s) to be searched + * @param[in] id is the pointer to semaphore id + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and + * *id filled in with the semaphore id */ rtems_status_code rtems_semaphore_ident( rtems_name name, |