From c05d75020d231aa193444a84c84d5ecaa1a4cefa Mon Sep 17 00:00:00 2001 From: Mathew Kallada 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/signal.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'cpukit/rtems/include/rtems/rtems/signal.h') diff --git a/cpukit/rtems/include/rtems/rtems/signal.h b/cpukit/rtems/include/rtems/rtems/signal.h index f804e5ef70..046842f97f 100644 --- a/cpukit/rtems/include/rtems/rtems/signal.h +++ b/cpukit/rtems/include/rtems/rtems/signal.h @@ -61,10 +61,15 @@ rtems_status_code rtems_signal_catch( ); /** - * @brief rtems_signal_send + * @brief RTEMS Send Signal * * This routine implements the rtems_signal_send directive. This directive * sends the signal_set to the task specified by ID. + * + * @param[in] id is the thread thread id + * @param[in] signal_set is the signal set + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_signal_send( rtems_id id, -- cgit v1.2.3