summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/signal.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/signal.h')
-rw-r--r--cpukit/rtems/include/rtems/rtems/signal.h44
1 files changed, 21 insertions, 23 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/signal.h b/cpukit/rtems/include/rtems/rtems/signal.h
index a516970ca4..5fe1702327 100644
--- a/cpukit/rtems/include/rtems/rtems/signal.h
+++ b/cpukit/rtems/include/rtems/rtems/signal.h
@@ -1,8 +1,6 @@
/**
* @file rtems/rtems/signal.h
- */
-
-/*
+ *
* This include file contains all the constants and structures associated
* with the Signal Manager. This manager provides capabilities required
* for asynchronous communication between tasks via signal sets.
@@ -11,8 +9,9 @@
*
* + establish an asynchronous signal routine
* + send a signal set to a task
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -25,9 +24,12 @@
#ifndef _RTEMS_RTEMS_SIGNAL_H
#define _RTEMS_RTEMS_SIGNAL_H
-#ifdef __cplusplus
-extern "C" {
-#endif
+/**
+ * @defgroup ClassicSignal Classic API Signal
+ *
+ * This encapsulates functionality which XXX
+ */
+/**@{*/
#include <rtems/rtems/asr.h>
#include <rtems/rtems/modes.h>
@@ -35,41 +37,35 @@ extern "C" {
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
-/*
- * _Signal_Manager_initialization
- *
- * DESCRIPTION:
+#ifdef __cplusplus
+extern "C" {
+#endif
+/**
+ * @brief _Signal_Manager_initialization
*
* This routine performs the initialization necessary for this manager.
*/
-
void _Signal_Manager_initialization( void );
-/*
- * rtems_signal_catch
- *
- * DESCRIPTION:
+/**
+ * @brief rtems_signal_catch
*
* 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.
*/
-
rtems_status_code rtems_signal_catch(
rtems_asr_entry asr_handler,
rtems_mode mode_set
);
-/*
- * rtems_signal_send
- *
- * DESCRIPTION:
+/**
+ * @brief rtems_signal_send
*
* This routine implements the rtems_signal_send directive. This directive
* sends the signal_set to the task specified by ID.
*/
-
rtems_status_code rtems_signal_send(
Objects_Id id,
rtems_signal_set signal_set
@@ -83,5 +79,7 @@ rtems_status_code rtems_signal_send(
}
#endif
+/**@}*/
+
#endif
/* end of include file */