arm: Improve Doxygen file comments

cpukit/score/cpu/arm/__aeabi_read_tp.c

@@ -1,5 +1,13 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of __aeabi_read_tp().
+ */
+
 /*
  * Copyright (c) 2014 embedded brains GmbH & Co. KG
  *

cpukit/score/cpu/arm/__tls_get_addr.c

@@ -1,5 +1,13 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of __tls_get_addr().
+ */
+
 /*
  * Copyright (C) 2014, 2015 embedded brains GmbH & Co. KG
  *

cpukit/score/cpu/arm/arm-exception-default.c

@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _ARM_Exception_default().
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH & Co. KG
  *

cpukit/score/cpu/arm/arm-exception-frame-print.c

@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _CPU_Exception_frame_print().
+ */
+
 /*
  * Copyright (C) 2012, 2013 embedded brains GmbH & Co. KG
  *

cpukit/score/cpu/arm/armv4-sync-synchronize.c

@@ -1,5 +1,13 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of __sync_synchronize().
+ */
+
 /*
  * Copyright (c) 2015 embedded brains GmbH & Co. KG
  *

cpukit/score/cpu/arm/armv7-thread-idle.c

@@ -1,9 +1,12 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
- *  @file
+ * @file
  *
- *  @brief CPU Thread Idle Body
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _CPU_Thread_Idle_body().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-context-initialize.c

@@ -1,9 +1,12 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
- *  @file
+ * @file
  *
- *  @brief CPU Initialize Context
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _CPU_Context_Initialize().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-context-restore.c

@@ -1,9 +1,12 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
- *  @file
+ * @file
  *
- *  @brief CPU Restore Context
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _CPU_Context_restore().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-context-switch.c

@@ -3,7 +3,10 @@
 /**
  * @file
  *
- * @brief ARM7M CPU Context Switch
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _CPU_Context_switch().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-exception-default.c

@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _ARMV7M_Exception_default().
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH & Co. KG
  *

cpukit/score/cpu/arm/armv7m-exception-handler-get.c

@@ -1,9 +1,12 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
- *  @file
+ * @file
  *
- *  @brief ARMV7M Get Exception Handler
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _ARMV7M_Get_exception_handler().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-exception-handler-set.c

@@ -1,9 +1,12 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
- *  @file
+ * @file
  *
- *  @brief ARMV7M Set Exception Handler
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _ARMV7M_Set_exception_handler().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-exception-priority-get.c

@@ -1,10 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
- *  @file
+ * @file
  *
- *  @brief ARMV7M Get Exception Priority
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _ARMV7M_Get_exception_priority().
  */
+
 /*
  * Copyright (c) 2011 Sebastian Huber.  All rights reserved.
  *

cpukit/score/cpu/arm/armv7m-exception-priority-handler.c

@@ -3,7 +3,10 @@
 /**
  * @file
  *
- * @brief ARMV7M Set Exception Priority and Handler
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _ARMV7M_Set_exception_priority_and_handler().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-exception-priority-set.c

@@ -1,9 +1,12 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
- *  @file
+ * @file
  *
- *  @brief ARMV7M Set Exception Priority
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _ARMV7M_Set_exception_priority().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-initialize.c

@@ -3,7 +3,9 @@
 /**
  * @file
  *
- * @brief ARM7M CPU Initialize
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of _CPU_Initialize().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-isr-dispatch.c

@@ -3,7 +3,10 @@
 /**
  * @file
  *
- * @brief ARMV7M ISR Dispatch
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _ARMV7M_Thread_dispatch().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-isr-enter-leave.c

@@ -1,9 +1,12 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
- *  @file
+ * @file
  *
- *  @brief ARMV7M Interrupt Service Enter and Leave
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _ARMV7M_Interrupt_service_enter() and _ARMV7M_Interrupt_service_leave().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-isr-level-get.c

@@ -1,9 +1,11 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
- *  @file
+ * @file
  *
- *  @brief CPU Get ISR Level
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of _CPU_ISR_Get_level().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-isr-level-set.c

@@ -1,9 +1,11 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
- *  @file
+ * @file
  *
- *  @brief CPU Set ISR Level
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of _CPU_ISR_Set_level().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-isr-vector-install.c

@@ -1,9 +1,12 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
- *  @file
+ * @file
  *
- *  @brief CPU ISR Vector Install
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _CPU_ISR_install_vector().
  */
 
 /*

cpukit/score/cpu/arm/armv7m-multitasking-start-stop.c

@@ -3,7 +3,10 @@
 /**
  * @file
  *
- * @brief ARMV7M Start Multitasking
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This source file contains the implementation of
+ *   _ARMV7M_Start_multitasking().
  */
 
 /*

cpukit/score/cpu/arm/cpu.c

@@ -5,7 +5,11 @@
  *
  * @ingroup RTEMSScoreCPUARM
  *
- * @brief ARM architecture support implementation.
+ * @brief This source file contains static assertions to ensure the consistency
+ *   of interfaces used in C and assembler and it contains the ARM-specific
+ *   implementation of _CPU_Initialize(), _CPU_ISR_Get_level(),
+ *   _CPU_ISR_Set_level(), _CPU_ISR_install_vector(),
+ *   _CPU_Context_Initialize(), and _CPU_Fatal_halt().
  */
 
 /*

cpukit/score/cpu/arm/include/rtems/asm.h

@@ -3,7 +3,10 @@
 /**
  * @file
  *
- * @brief ARM Assembler Support API
+ * @ingroup RTEMSScoreCPUARMASM
+ *
+ * @brief This header file provides interfaces to address problems caused by
+ *   incompatible flavor of assemblers and toolsets.
  *
  * This include file attempts to address the problems
  * caused by incompatible flavors of assemblers and

cpukit/score/cpu/arm/include/rtems/score/armv4.h

@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This header file provides interfaces of the ARMv4 architecture
+ *   support.
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH & Co. KG
  *
@@ -34,6 +43,12 @@
 extern "C" {
 #endif /* __cplusplus */
 
+/**
+ * @addtogroup RTEMSScoreCPUARM
+ *
+ * @{
+ */
+
 #ifdef ARM_MULTILIB_ARCH_V4
 
 void bsp_interrupt_dispatch( void );
@@ -104,6 +119,8 @@ static inline void _ARMV4_Status_restore( uint32_t psr )
 
 #endif /* ARM_MULTILIB_ARCH_V4 */
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */

cpukit/score/cpu/arm/include/rtems/score/armv7m.h

@@ -3,7 +3,10 @@
 /**
  * @file
  *
- * @brief ARMV7M Architecture Support
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This header file provides interfaces of the ARMv7-M architecture
+ *   support.
  */
 
 /*

cpukit/score/cpu/arm/include/rtems/score/cpu.h

@@ -3,7 +3,10 @@
 /**
  * @file
  *
- * @brief ARM Architecture Support API
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This header file defines implementation interfaces pertaining to the
+ *   port of the executive to the ARM architecture.
  */
 
 /*

cpukit/score/cpu/arm/include/rtems/score/cpuimpl.h

@@ -3,7 +3,10 @@
 /**
  * @file
  *
- * @brief CPU Port Implementation API
+ * @ingroup RTEMSScoreCPUARM
+ *
+ * @brief This header file defines implementation interfaces pertaining to the
+ *   port of the executive to the ARM architecture.
  */
 
 /*

cpukit/score/cpu/arm/include/rtems/score/paravirt.h

@@ -3,10 +3,10 @@
 /**
  * @file
  *
- * @brief ARM Paravirtualization Definitions
+ * @ingroup RTEMSScoreCPUARMParavirt
  *
- * This include file contains definitions pertaining to paravirtualization
- * of the ARM port.
+ * @brief This header file provides definitions pertaining to
+ *   paravirtualization of the ARM port.
  */
 
 /*