From 88c47041f9ecb5c1e47ce5953f84e64f92048d49 Mon Sep 17 00:00:00 2001 From: Alex Ivanov Date: Sun, 2 Dec 2012 16:59:17 -0600 Subject: 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 --- cpukit/rtems/include/rtems/rtems/sem.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'cpukit/rtems/include/rtems/rtems/sem.h') 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, -- cgit v1.2.3