From 205dbb9df9c8d39c955d6b807a59e258c319ad3d Mon Sep 17 00:00:00 2001 From: Alex Ivanov Date: Mon, 3 Dec 2012 13:18:33 -0600 Subject: cpukit: Clean up Doxygen #3 (GCI 2012) --- cpukit/rtems/include/rtems/rtems/signal.h | 8 +++++++- 1 file changed, 7 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 046842f97f..54359ccfaa 100644 --- a/cpukit/rtems/include/rtems/rtems/signal.h +++ b/cpukit/rtems/include/rtems/rtems/signal.h @@ -48,12 +48,18 @@ extern "C" { void _Signal_Manager_initialization( void ); /** - * @brief rtems_signal_catch + * @brief RTEMS Catch Signal * * This routine implements the rtems_signal_catch directive. This directive * is used to establish asr_handler as the Asynchronous Signal Routine * (RTEMS_ASR) for the calling task. The asr_handler will execute with a * mode of mode_set. + * + * @param[in] asr_handler is the address of asynchronous signal routine (asr) + * ( NULL indicates asr is invalid ) + * @param[in] mode_set is the mode value for asr + * + * @return RTEMS_SUCCESSFUL */ rtems_status_code rtems_signal_catch( rtems_asr_entry asr_handler, -- cgit v1.2.3