[rtems commit] rtems: Canonicalize task event file documentation

[Sebastian Huber]

Module:    rtems
Branch:    master
Commit:    72811c71af08d778f6d24dea77a36bffb2ab4809
Changeset: http://git.rtems.org/rtems/commit/?id=72811c71af08d778f6d24dea77a36bffb2ab4809

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Oct 14 10:57:35 2020 +0200

rtems: Canonicalize task event file documentation

---

 cpukit/include/rtems/rtems/eventdata.h | 3 ++-
 cpukit/include/rtems/rtems/eventimpl.h | 2 +-
 cpukit/rtems/src/eventmp.c             | 8 +++++---
 cpukit/rtems/src/eventreceive.c        | 5 +++--
 cpukit/rtems/src/eventseize.c          | 5 +++--
 cpukit/rtems/src/eventsend.c           | 8 +++++---
 cpukit/rtems/src/eventsurrender.c      | 8 +++++---
 cpukit/rtems/src/systemeventreceive.c  | 5 +++--
 cpukit/rtems/src/systemeventsend.c     | 5 +++--
 9 files changed, 30 insertions(+), 19 deletions(-)

diff --git a/cpukit/include/rtems/rtems/eventdata.h b/cpukit/include/rtems/rtems/eventdata.h
index 16ff7a3..fa69a2a 100644
--- a/cpukit/include/rtems/rtems/eventdata.h
+++ b/cpukit/include/rtems/rtems/eventdata.h
@@ -3,7 +3,8 @@
  *
  * @ingroup ClassicEventImpl
  *
- * @brief Classic Event Manager Data Structures
+ * @brief This header file provides the API used by the Application
+ *   Configuration to define the configured Thread Control Block (TCB).
  */
 
 /* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/include/rtems/rtems/eventimpl.h b/cpukit/include/rtems/rtems/eventimpl.h
index 21a4884..141ea46 100644
--- a/cpukit/include/rtems/rtems/eventimpl.h
+++ b/cpukit/include/rtems/rtems/eventimpl.h
@@ -3,7 +3,7 @@
  *
  * @ingroup ClassicEventImpl
  *
- * @brief Classic Event Manager Implementation
+ * @brief This header file provides interfaces used by the event implementation.
  */
 
 /*  COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/rtems/src/eventmp.c b/cpukit/rtems/src/eventmp.c
index ee971a7..a31476a 100644
--- a/cpukit/rtems/src/eventmp.c
+++ b/cpukit/rtems/src/eventmp.c
@@ -1,8 +1,10 @@
 /**
- *  @file
+ * @file
  *
- *  @brief Event MP Support
- *  @ingroup ClassicEventMP
+ * @ingroup ClassicEventMP
+ *
+ * @brief This source file contains the implementation of the task event MPCI
+ *   support.
  */
 
 /*
diff --git a/cpukit/rtems/src/eventreceive.c b/cpukit/rtems/src/eventreceive.c
index c638ec5..fc5886b 100644
--- a/cpukit/rtems/src/eventreceive.c
+++ b/cpukit/rtems/src/eventreceive.c
@@ -1,9 +1,10 @@
 /**
  * @file
  *
- * @ingroup ClassicEventSet Event Set
+ * @ingroup ClassicEventImpl
  *
- * @brief  Constant used to receive the set of currently pending events in
+ * @brief This source file contains the implementation of
+ *   rtems_event_receive().
  */
 
 /*
diff --git a/cpukit/rtems/src/eventseize.c b/cpukit/rtems/src/eventseize.c
index 8230959..874c142 100644
--- a/cpukit/rtems/src/eventseize.c
+++ b/cpukit/rtems/src/eventseize.c
@@ -1,9 +1,10 @@
 /**
  * @file
  *
- * @ingroup ClassicEvent Events
+ * @ingroup ClassicEventImpl
  *
- * @brief Event Manager Initialization
+ * @brief This source file contains the implementation of
+ *   _Event_Seize() and the task event MPCI support system initialization.
  */
 
 /*
diff --git a/cpukit/rtems/src/eventsend.c b/cpukit/rtems/src/eventsend.c
index cfd091c..470b7f4 100644
--- a/cpukit/rtems/src/eventsend.c
+++ b/cpukit/rtems/src/eventsend.c
@@ -1,8 +1,10 @@
 /**
- *  @file
+ * @file
  *
- *  @brief Sends an Event Set to the Target Task
- *  @ingroup ClassicEvent
+ * @ingroup ClassicEventImpl
+ *
+ * @brief This source file contains the implementation of
+ *   rtems_event_send().
  */
 
 /*
diff --git a/cpukit/rtems/src/eventsurrender.c b/cpukit/rtems/src/eventsurrender.c
index 49f77d2..6cdaafa 100644
--- a/cpukit/rtems/src/eventsurrender.c
+++ b/cpukit/rtems/src/eventsurrender.c
@@ -1,8 +1,10 @@
 /**
- *  @file
+ * @file
  *
- *  @brief Surrender Event
- *  @ingroup ClassicEvent
+ * @ingroup ClassicEventImpl
+ *
+ * @brief This source file contains the implementation of
+ *   _Event_Surrender().
  */
 
 /*
diff --git a/cpukit/rtems/src/systemeventreceive.c b/cpukit/rtems/src/systemeventreceive.c
index ee25260..30e5adc 100644
--- a/cpukit/rtems/src/systemeventreceive.c
+++ b/cpukit/rtems/src/systemeventreceive.c
@@ -1,9 +1,10 @@
 /**
  * @file
  *
- * @ingroup ClassicEventSystem
+ * @ingroup ClassicEventImpl
  *
- * @brief rtems_event_system_receive() implementation.
+ * @brief This source file contains the implementation of
+ *   rtems_event_system_receive().
  */
 
 /*
diff --git a/cpukit/rtems/src/systemeventsend.c b/cpukit/rtems/src/systemeventsend.c
index e939d77..6a83ec4 100644
--- a/cpukit/rtems/src/systemeventsend.c
+++ b/cpukit/rtems/src/systemeventsend.c
@@ -1,9 +1,10 @@
 /**
  * @file
  *
- * @ingroup ClassicEventSystem
+ * @ingroup ClassicEventImpl
  *
- * @brief rtems_event_system_send() implementation.
+ * @brief This source file contains the implementation of
+ *   rtems_event_system_send().
  */
 
 /*