[rtems commit] doxygen: score: Add i386 CPU architecture group

Sebastian Huber sebh at rtems.org
Tue Apr 2 05:31:47 UTC 2019


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

Author:    Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date:      Tue Mar 26 09:02:04 2019 +0100

doxygen: score: Add i386 CPU architecture group

Update #3706.

---

 cpukit/score/cpu/i386/include/rtems/asm.h              | 11 +++++++++++
 cpukit/score/cpu/i386/include/rtems/score/cpu.h        | 11 +++++++++++
 cpukit/score/cpu/i386/include/rtems/score/cpuimpl.h    | 12 ++++++++++++
 cpukit/score/cpu/i386/include/rtems/score/i386.h       |  2 ++
 cpukit/score/cpu/i386/include/rtems/score/idtr.h       |  2 ++
 cpukit/score/cpu/i386/include/rtems/score/interrupts.h | 10 ++++++++++
 cpukit/score/cpu/i386/include/rtems/score/paravirt.h   |  9 +++++++--
 cpukit/score/cpu/i386/include/rtems/score/registers.h  |  2 ++
 8 files changed, 57 insertions(+), 2 deletions(-)

diff --git a/cpukit/score/cpu/i386/include/rtems/asm.h b/cpukit/score/cpu/i386/include/rtems/asm.h
index 50b0fd7..5db402c 100644
--- a/cpukit/score/cpu/i386/include/rtems/asm.h
+++ b/cpukit/score/cpu/i386/include/rtems/asm.h
@@ -39,6 +39,15 @@
 #include <rtems/score/cpuopts.h>
 #include <rtems/score/i386.h>
 
+/**
+ * @defgroup RTEMSScoreCPUi386ASM i386 Assembler Support
+ *
+ * @ingroup RTEMSScoreCPUi386
+ *
+ * @brief i386 Assembler Support
+ */
+/**@{**/
+
 /*
  *  Recent versions of GNU cpp define variables which indicate the
  *  need for underscores and percents.  If not using GNU cpp or
@@ -137,4 +146,6 @@
 #define PUBLIC(sym) .globl SYM (sym)
 #define EXTERN(sym) .globl SYM (sym)
 
+/**@}**/
+
 #endif
diff --git a/cpukit/score/cpu/i386/include/rtems/score/cpu.h b/cpukit/score/cpu/i386/include/rtems/score/cpu.h
index 10614a7..19562e7 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/cpu.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/cpu.h
@@ -32,6 +32,15 @@ extern "C" {
 #include <rtems/score/paravirt.h>
 #endif
 #include <rtems/score/i386.h>
+    
+/**
+ * @defgroup ScoreCPUi386 i386 Specific Support
+ *
+ * @ingroup RTEMSScoreCPUi386
+ *
+ * @brief i386 specific support.
+ */
+/**@{**/
 
 /* conditional compilation parameters */
 
@@ -649,6 +658,8 @@ static inline CPU_Counter_ticks _CPU_Counter_difference(
   return second - first;
 }
 
+/**@}**/
+
 /** Type that can store a 32-bit integer or a pointer. */
 typedef uintptr_t CPU_Uint32ptr;
 
diff --git a/cpukit/score/cpu/i386/include/rtems/score/cpuimpl.h b/cpukit/score/cpu/i386/include/rtems/score/cpuimpl.h
index 78b87ef..a89b1fe 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/cpuimpl.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/cpuimpl.h
@@ -17,6 +17,16 @@
 
 #include <rtems/score/cpu.h>
 
+/**
+ * @defgroup RTEMSScoreCPUi386 i386
+ *
+ * @ingroup RTEMSScoreCPU
+ *
+ * @brief i386 Architecture Support
+ *
+ * @{
+ */
+
 #define CPU_PER_CPU_CONTROL_SIZE 0
 
 #ifndef ASM
@@ -53,4 +63,6 @@ RTEMS_INLINE_ROUTINE void _CPU_Instruction_no_operation( void )
 
 #endif /* ASM */
 
+/** @} */
+
 #endif /* _RTEMS_SCORE_CPUIMPL_H */
diff --git a/cpukit/score/cpu/i386/include/rtems/score/i386.h b/cpukit/score/cpu/i386/include/rtems/score/i386.h
index 4b94e6f..5490110 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/i386.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/i386.h
@@ -2,6 +2,8 @@
  * @file
  *
  * @brief Intel I386 CPU Dependent Source
+ * 
+ * @addtogroup RTEMSScoreCPUi386
  *
  * This include file contains information pertaining to the Intel
  * i386 processor.
diff --git a/cpukit/score/cpu/i386/include/rtems/score/idtr.h b/cpukit/score/cpu/i386/include/rtems/score/idtr.h
index a79af40..c40fce1 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/idtr.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/idtr.h
@@ -3,6 +3,8 @@
  * 
  * @brief Intel I386 Data Structures
  * 
+ * @addtogroup RTEMSScoreCPUi386
+ * 
  * This file contains definitions for data structure related
  *          to Intel system programming. More information can be found
  *          on Intel site and more precisely in the following book :
diff --git a/cpukit/score/cpu/i386/include/rtems/score/interrupts.h b/cpukit/score/cpu/i386/include/rtems/score/interrupts.h
index b682772..cac9ba9 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/interrupts.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/interrupts.h
@@ -16,6 +16,15 @@
  *  Applications must not include this file directly.
  */
 
+/**
+ * @defgroup RTEMSScoreCPUi386Interrupt Processor Dependent Interrupt Management
+ *
+ * @ingroup RTEMSScoreCPUi386
+ *
+ * @brief i386 Interrupt Management
+ */
+/**@{**/
+
 #ifndef _RTEMS_SCORE_INTERRUPTS_H
 #define _RTEMS_SCORE_INTERRUPTS_H
 
@@ -81,5 +90,6 @@ uint32_t i386_get_interrupt_level( void );
 
 /** @} */
 
+/**@}**/
 #endif
 #endif
diff --git a/cpukit/score/cpu/i386/include/rtems/score/paravirt.h b/cpukit/score/cpu/i386/include/rtems/score/paravirt.h
index 40eddb8..1b26226 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/paravirt.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/paravirt.h
@@ -25,10 +25,12 @@
 #define _RTEMS_SCORE_PARAVIRT_H
 
 /**
- * @defgroup Paravirti386 Paravirtualization i386 Support
+ * @defgroup RTEMSScoreCPUi386Paravirt i386 Paravirtualization Support
  *
- * @ingroup Score
+ * @ingroup RTEMSScoreCPUi386
  *
+ * @{
+ * 
  * This handler encapulates the functionality (primarily conditional
  * feature defines) related to paravirtualization on the i386.
  *
@@ -40,6 +42,7 @@
  *     hosting environment.
  */
 
+
 #ifndef ASM
 
 #ifdef __cplusplus
@@ -61,3 +64,5 @@ extern "C" {
 #define I386_DISABLE_INLINE_ISR_DISABLE_ENABLE
 
 #endif
+
+/** @} */
diff --git a/cpukit/score/cpu/i386/include/rtems/score/registers.h b/cpukit/score/cpu/i386/include/rtems/score/registers.h
index 254fef7..79c0ec3 100644
--- a/cpukit/score/cpu/i386/include/rtems/score/registers.h
+++ b/cpukit/score/cpu/i386/include/rtems/score/registers.h
@@ -3,6 +3,8 @@
  * 
  * @brief Intel CPU Constants and Definitions
  * 
+ * @addtogroup RTEMSScoreCPUi386
+ * 
  * This file contains definition and constants related to Intel Cpu
  */
 



More information about the vc mailing list