score: Doxygen Clean Up Task #3

5 files changed, 131 insertions, 73 deletions

diff --git a/cpukit/score/cpu/mips/rtems/mips/idtcpu.h b/cpukit/score/cpu/mips/rtems/mips/idtcpu.h
index c1a934098f..746129e116 100644
--- a/cpukit/score/cpu/mips/rtems/mips/idtcpu.h
+++ b/cpukit/score/cpu/mips/rtems/mips/idtcpu.h
@@ -1,33 +1,46 @@
-/*
-
-Based upon IDT provided code with the following release:
-
-This source code has been made available to you by IDT on an AS-IS
-basis. Anyone receiving this source is licensed under IDT copyrights
-to use it in any way he or she deems fit, including copying it,
-modifying it, compiling it, and redistributing it either with or
-without modifications.  No license under IDT patents or patent
-applications is to be implied by the copyright license.
-
-Any user of this software should understand that IDT cannot provide
-technical support for this software and will not be responsible for
-any consequences resulting from the use of this software.
-
-Any person who transfers this source code or any derivative work must
-include the IDT copyright notice, this paragraph, and the preceeding
-two paragraphs in the transferred software.
-
-COPYRIGHT IDT CORPORATION 1996
-LICENSED MATERIAL - PROGRAM PROPERTY OF IDT
-*/
+/**
+ *  @file idtcpu.h
+ *
+ *  @brief CPU Related Definitions
+ *
+ * 950313: Ketan added sreg/lreg and R_SZ for 64-bit saves
+ *         added Register definition for XContext reg.
+ *         Look towards end of this file.
+ */
 
 /*
-** idtcpu.h -- cpu related defines
-*/
+ * Based upon IDT provided code with the following release:
+ *
+ * This source code has been made available to you by IDT on an AS-IS
+ * basis. Anyone receiving this source is licensed under IDT copyrights
+ * to use it in any way he or she deems fit, including copying it,
+ * modifying it, compiling it, and redistributing it either with or
+ * without modifications.  No license under IDT patents or patent
+ * applications is to be implied by the copyright license.
+ *
+ * Any user of this software should understand that IDT cannot provide
+ * technical support for this software and will not be responsible for
+ * any consequences resulting from the use of this software.
+ *
+ * Any person who transfers this source code or any derivative work must
+ * include the IDT copyright notice, this paragraph, and the preceeding
+ * two paragraphs in the transferred software.
+ *
+ * COPYRIGHT IDT CORPORATION 1996
+ * LICENSED MATERIAL - PROGRAM PROPERTY OF IDT
+ */
 
 #ifndef _RTEMS_MIPS_IDTCPU_H
 #define _RTEMS_MIPS_IDTCPU_H
 
+/**
+ *  @defgroup MipsSet_idtcpu CPU Related Definitions
+ *
+ *  @ingroup MIPS
+ *
+ */
+/**@{*/
+
 /*
  * 950313: Ketan added Register definition for XContext reg.
  *               added define for WAIT instruction.
@@ -92,7 +105,7 @@ LICENSED MATERIAL - PROGRAM PROPERTY OF IDT
 **	Cache size constants
 */
 #define	MINCACHE	0x200		/* 512       For 3041. */
-#define	MAXCACHE	0x40000		/* 256*1024   256k */	
+#define	MAXCACHE	0x40000		/* 256*1024   256k */
 
 #if  __mips == 32
 /* R4000 configuration register definitions */
@@ -691,5 +704,5 @@ LICENSED MATERIAL - PROGRAM PROPERTY OF IDT
 #define CALG	$17
 #endif
 
-#endif /* _RTEMS_MIPS_IDTCPU_H */
-
+/**@}*/
+#endif /* _RTEMS_MIPS_IDTCPU_H */
\ No newline at end of file
diff --git a/cpukit/score/cpu/mips/rtems/mips/iregdef.h b/cpukit/score/cpu/mips/rtems/mips/iregdef.h
index 631e5aa178..0dc9de7acc 100644
--- a/cpukit/score/cpu/mips/rtems/mips/iregdef.h
+++ b/cpukit/score/cpu/mips/rtems/mips/iregdef.h
@@ -1,44 +1,51 @@
-/*
-
-Based upon IDT provided code with the following release:
-
-This source code has been made available to you by IDT on an AS-IS
-basis. Anyone receiving this source is licensed under IDT copyrights
-to use it in any way he or she deems fit, including copying it,
-modifying it, compiling it, and redistributing it either with or
-without modifications.  No license under IDT patents or patent
-applications is to be implied by the copyright license.
-
-Any user of this software should understand that IDT cannot provide
-technical support for this software and will not be responsible for
-any consequences resulting from the use of this software.
-
-Any person who transfers this source code or any derivative work must
-include the IDT copyright notice, this paragraph, and the preceeding
-two paragraphs in the transferred software.
-
-COPYRIGHT IDT CORPORATION 1996
-LICENSED MATERIAL - PROGRAM PROPERTY OF IDT
-
+/**
+ *  @file iregdef.h
+ *
+ *  @brief IDT R3000 Register Structure
+ *
+ * 950313: Ketan added sreg/lreg and R_SZ for 64-bit saves
+ *         added Register definition for XContext reg.
+ *         Look towards end of this file.
+ */
 
 /*
-**	iregdef.h - IDT R3000 register structure header file
-**
-**	Copyright 1989 Integrated Device Technology, Inc
-**	All Rights Reserved
-**
-*/
+ *	Copyright 1989 Integrated Device Technology, Inc
+ *	All Rights Reserved
+ *
+ * Based upon IDT provided code with the following release:
+ *
+ * This source code has been made available to you by IDT on an AS-IS
+ * basis. Anyone receiving this source is licensed under IDT copyrights
+ * to use it in any way he or she deems fit, including copying it,
+ * modifying it, compiling it, and redistributing it either with or
+ * without modifications.  No license under IDT patents or patent
+ * applications is to be implied by the copyright license.
+ *
+ * Any user of this software should understand that IDT cannot provide
+ * technical support for this software and will not be responsible for
+ * any consequences resulting from the use of this software.
+ *
+ * Any person who transfers this source code or any derivative work must
+ * include the IDT copyright notice, this paragraph, and the preceeding
+ * two paragraphs in the transferred software.
+ *
+ * COPYRIGHT IDT CORPORATION 1996
+ * LICENSED MATERIAL - PROGRAM PROPERTY OF IDT
+ */
+
 #ifndef _RTEMS_MIPS_IREGDEF_H
 #define _RTEMS_MIPS_IREGDEF_H
 
-/*
- * 950313: Ketan added sreg/lreg and R_SZ for 64-bit saves
- *         added Register definition for XContext reg.
- *         Look towards end of this file.
+/**
+ *  @defgroup MipsSet_iregdef Register Structure
+ *
+ *  @ingroup MIPS
+ *
  */
-/*
-** register names
-*/
+/**@{*/
+
+/* register names */
+
 #define r0	$0
 #define r1	$1
 #define r2	$2
@@ -326,5 +333,5 @@ LICENSED MATERIAL - PROGRAM PROPERTY OF IDT
 /* Ketan till here */
 #endif
 
-#endif /* _RTEMS_MIPS_IREGDEF_H */
-
+/**@}*/
+#endif /* _RTEMS_MIPS_IREGDEF_H */
\ No newline at end of file
diff --git a/cpukit/score/cpu/mips/rtems/score/cpu.h b/cpukit/score/cpu/mips/rtems/score/cpu.h
index 1da23db423..64686ffb25 100644
--- a/cpukit/score/cpu/mips/rtems/score/cpu.h
+++ b/cpukit/score/cpu/mips/rtems/score/cpu.h
@@ -1,7 +1,7 @@
 /**
  *  @file
- *  
- *  Mips CPU Dependent Header File
+ *
+ *  @brief Mips CPU Dependent Header File
  *
  *  Conversion to MIPS port by Alan Cudmore <alanc@linuxstart.com> and
  *           Joel Sherrill <joel@OARcorp.com>.
@@ -42,6 +42,14 @@
 #ifndef _RTEMS_SCORE_CPU_H
 #define _RTEMS_SCORE_CPU_H
 
+/**
+ *  @defgroup ScoreCPU CPU CPU
+ *
+ *  @ingroup Score
+ *
+ */
+/**@{*/
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -211,7 +219,7 @@ extern "C" {
  *  all tasks floating point.
  */
 
-#define CPU_ALL_TASKS_ARE_FP CPU_HARDWARE_FP 
+#define CPU_ALL_TASKS_ARE_FP CPU_HARDWARE_FP
 
 /*
  *  Should the IDLE task have a floating point context?
@@ -1172,4 +1180,5 @@ static inline uint32_t CPU_swap_u32(
 }
 #endif
 
-#endif
+/**@}*/
+#endif
\ No newline at end of file
diff --git a/cpukit/score/cpu/mips/rtems/score/mips.h b/cpukit/score/cpu/mips/rtems/score/mips.h
index f81fd32ec2..e9b03c059b 100644
--- a/cpukit/score/cpu/mips/rtems/score/mips.h
+++ b/cpukit/score/cpu/mips/rtems/score/mips.h
@@ -1,5 +1,14 @@
 /**
  * @file rtems/score/mips.h
+ *
+ * @brief Information to build RTEMS for a "no cpu" while in protected mode.
+ *
+ *  This file contains the information required to build
+ *  RTEMS for a particular member of the "no cpu"
+ *  family when executing in protected mode.  It does
+ *  this by setting variables to indicate which implementation
+ *  dependent features are present in a particular member
+ *  of the family.
  */
 
 /*
@@ -14,6 +23,14 @@
 #ifndef _RTEMS_SCORE_MIPS_H
 #define _RTEMS_SCORE_MIPS_H
 
+/**
+ *  @defgroup ScoreMips RTEMS no cpu Build Information
+ *
+ *  @ingroup Score
+ *
+ */
+/**@{*/
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -277,5 +294,6 @@ extern "C" {
 }
 #endif
 
+/**@}*/
 #endif /* _RTEMS_SCORE_MIPS_H */
-/* end of include file */
+/* end of include file */
\ No newline at end of file
diff --git a/cpukit/score/cpu/mips/rtems/score/types.h b/cpukit/score/cpu/mips/rtems/score/types.h
index f26819a739..5885402daf 100644
--- a/cpukit/score/cpu/mips/rtems/score/types.h
+++ b/cpukit/score/cpu/mips/rtems/score/types.h
@@ -1,11 +1,13 @@
 /**
  * @file rtems/score/types.h
+ *
+ * @brief Type Definitions Pertaining to the MIPS Processor Family
+ *
+ *  This include file contains type definitions pertaining to the MIPS
+ *  processor family.
  */
 
 /*
- *  This include file contains type definitions pertaining to the MIPS
- *  processor family.
- *
  *  COPYRIGHT (c) 1989-2001.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -18,6 +20,14 @@
 #ifndef _RTEMS_SCORE_TYPES_H
 #define _RTEMS_SCORE_TYPES_H
 
+/**
+ *  @defgroup ScoreTypes MIPS Processor Family Type Definitions
+ *
+ *  @ingroup Score
+ *
+ */
+/**@{*/
+
 #include <rtems/score/basedefs.h>
 
 #ifndef ASM
@@ -40,4 +50,5 @@ typedef void ( *mips_isr_entry )( void );
 
 #endif  /* !ASM */
 
-#endif
+/**@}*/
+#endif
\ No newline at end of file