[PATCH 18/25] Reviewed @defgroup in cpukit/include/rtems/score

Sebastian Huber sebastian.huber at embedded-brains.de
Fri Mar 29 10:53:03 UTC 2019


From: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>

Update #3706.
---
 cpukit/include/rtems/score/isrlevel.h    |  8 ++------
 cpukit/include/rtems/score/profiling.h   |  2 ++
 cpukit/include/rtems/score/smpimpl.h     |  4 +---
 cpukit/include/rtems/score/smplock.h     | 32 ++++++++++++++++----------------
 cpukit/include/rtems/score/todimpl.h     |  4 +---
 cpukit/include/rtems/score/userextimpl.h | 10 +++-------
 6 files changed, 25 insertions(+), 35 deletions(-)

diff --git a/cpukit/include/rtems/score/isrlevel.h b/cpukit/include/rtems/score/isrlevel.h
index 9222e1871c..aadce022e6 100644
--- a/cpukit/include/rtems/score/isrlevel.h
+++ b/cpukit/include/rtems/score/isrlevel.h
@@ -27,13 +27,9 @@ extern "C" {
 #endif
 
 /**
- *  @defgroup ScoreISR ISR Handler
- *
- *  @ingroup Score
- *
  *  @addtogroup ScoreISR ISR Handler
  */
-/**@{*/
+/** @{ */
 
 /**
  *  The following type defines the control block used to manage
@@ -145,7 +141,7 @@ typedef uint32_t   ISR_Level;
     RTEMS_COMPILER_MEMORY_BARRIER();  \
   } while (0)
 
-/**@}*/
+/** @} */
 
 #ifdef __cplusplus
 }
diff --git a/cpukit/include/rtems/score/profiling.h b/cpukit/include/rtems/score/profiling.h
index 6ba5d2987f..5f9f2c2a50 100644
--- a/cpukit/include/rtems/score/profiling.h
+++ b/cpukit/include/rtems/score/profiling.h
@@ -32,6 +32,8 @@ extern "C" {
 
 /**
  * @defgroup ScoreProfiling Profiling Support
+ * 
+ * @ingroup Score
  *
  * @brief Profiling support.
  *
diff --git a/cpukit/include/rtems/score/smpimpl.h b/cpukit/include/rtems/score/smpimpl.h
index 532e5a6b4e..0e6168362c 100644
--- a/cpukit/include/rtems/score/smpimpl.h
+++ b/cpukit/include/rtems/score/smpimpl.h
@@ -29,9 +29,7 @@ extern "C" {
 #endif
 
 /**
- * @defgroup ScoreSMP SMP Support
- *
- * @ingroup Score
+ * @addtogroup ScoreSMP
  *
  * This defines the interface of the SuperCore SMP support.
  *
diff --git a/cpukit/include/rtems/score/smplock.h b/cpukit/include/rtems/score/smplock.h
index a156edfd92..096f8ba0c4 100644
--- a/cpukit/include/rtems/score/smplock.h
+++ b/cpukit/include/rtems/score/smplock.h
@@ -22,21 +22,6 @@
 
 #include <rtems/score/cpuopts.h>
 
-#if defined(RTEMS_SMP)
-
-#include <rtems/score/smplockstats.h>
-#include <rtems/score/smplockticket.h>
-#include <rtems/score/isrlevel.h>
-
-#if defined(RTEMS_DEBUG)
-#include <rtems/score/assert.h>
-#include <rtems/score/smp.h>
-#endif
-
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-
 /**
  * @defgroup ScoreSMPLock SMP Locks
  *
@@ -55,6 +40,21 @@ extern "C" {
  * @{
  */
 
+#if defined(RTEMS_SMP)
+
+#include <rtems/score/smplockstats.h>
+#include <rtems/score/smplockticket.h>
+#include <rtems/score/isrlevel.h>
+
+#if defined(RTEMS_DEBUG)
+#include <rtems/score/assert.h>
+#include <rtems/score/smp.h>
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
 #if defined(RTEMS_DEBUG) || defined(RTEMS_PROFILING)
 #define RTEMS_SMP_LOCK_DO_NOT_INLINE
 #endif
@@ -316,7 +316,7 @@ void _SMP_lock_Release_and_ISR_enable(
 bool _SMP_lock_Is_owner( const SMP_lock_Control *lock );
 #endif
 
-/**@}*/
+/** @} */
 
 #ifdef __cplusplus
 }
diff --git a/cpukit/include/rtems/score/todimpl.h b/cpukit/include/rtems/score/todimpl.h
index d2b6d73802..edc12e1fda 100644
--- a/cpukit/include/rtems/score/todimpl.h
+++ b/cpukit/include/rtems/score/todimpl.h
@@ -118,9 +118,7 @@ extern "C" {
 #define TOD_BASE_YEAR 1988
 
 /**
- *  @defgroup ScoreTOD Time Of Day (TOD) Handler
- *
- *  @ingroup Score
+ *  @addtogroup ScoreTOD
  *
  *  This handler encapsulates functionality used to manage time of day.
  */
diff --git a/cpukit/include/rtems/score/userextimpl.h b/cpukit/include/rtems/score/userextimpl.h
index 77357b9fed..6c5aae7640 100644
--- a/cpukit/include/rtems/score/userextimpl.h
+++ b/cpukit/include/rtems/score/userextimpl.h
@@ -29,13 +29,9 @@ extern "C" {
 #endif
 
 /**
- * @defgroup ScoreUserExt User Extension Handler
- *
- * @ingroup Score
- *
  * @addtogroup ScoreUserExt
  */
-/**@{**/
+/** @{ **/
 
 /**
  * @brief Chain iterator for dynamic user extensions.
@@ -82,7 +78,7 @@ extern Chain_Control _User_extensions_Switches_list;
 /**
  * @name Extension Maintainance
  */
-/**@{**/
+/** @{ **/
 
 void _User_extensions_Handler_initialization( void );
 
@@ -200,7 +196,7 @@ void _User_extensions_Iterate(
 /**
  * @name Extension Callout Dispatcher
  */
-/**@{**/
+/** @{ **/
 
 static inline bool _User_extensions_Thread_create( Thread_Control *created )
 {
-- 
2.16.4




More information about the devel mailing list