From 52adc808422cf415027c07c54910086227bcb973 Mon Sep 17 00:00:00 2001 From: Alex Ivanov Date: Sun, 2 Dec 2012 10:03:09 -0600 Subject: score misc: Clean up Doxygen #12 (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/8025203 --- cpukit/rtems/include/rtems/rtems/sem.h | 12 +++++++++++- 1 file changed, 11 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 c15d9eede2..4475d030c2 100644 --- a/cpukit/rtems/include/rtems/rtems/sem.h +++ b/cpukit/rtems/include/rtems/rtems/sem.h @@ -185,8 +185,18 @@ rtems_status_code rtems_semaphore_release( ); /** - * @brief rtems_semaphore_flush + * @brief RTEMS Semaphore Flush + * + * DESCRIPTION: + * This package is the implementation of the flush directive + * of the Semaphore Manager. + * + * This directive allows a thread to flush the threads * pending on the semaphore. + * + * @param[in] id is the semaphore id + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_semaphore_flush( rtems_id id -- cgit v1.2.3