[PATCH 1/1] Doxygen comments for NIOSII score file completed by Mat as part of Google Code In

[Cynthia Rempel]

diff --git a/cpukit/score/cpu/nios2/nios2-context-initialize.c b/cpukit/score/cpu/nios2/nios2-context-initialize.c
index e74e04f..02f985b 100644
--- a/cpukit/score/cpu/nios2/nios2-context-initialize.c
+++ b/cpukit/score/cpu/nios2/nios2-context-initialize.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Initializes the CPU context.
+ * @ingroup
+ */
+
 /*
  * Copyright (c) 2011 embedded brains GmbH
  *
diff --git a/cpukit/score/cpu/nios2/nios2-fatal-halt.c b/cpukit/score/cpu/nios2/nios2-fatal-halt.c
index 350c339..af272e1 100644
--- a/cpukit/score/cpu/nios2/nios2-fatal-halt.c
+++ b/cpukit/score/cpu/nios2/nios2-fatal-halt.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief CPU Fatal Halt
+ * @ingroup
+ */
+
 /*
  *  Copyright (c) 2011 embedded brains GmbH
  *
diff --git a/cpukit/score/cpu/nios2/nios2-initialize-vectors.c b/cpukit/score/cpu/nios2/nios2-initialize-vectors.c
index ff62499..8bd7477 100644
--- a/cpukit/score/cpu/nios2/nios2-initialize-vectors.c
+++ b/cpukit/score/cpu/nios2/nios2-initialize-vectors.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Macro to disable interrupts.
+ * @ingroup
+ */
+
 /*
  * Copyright (c) 2011 embedded brains GmbH
  *
diff --git a/cpukit/score/cpu/nios2/nios2-isr-get-level.c b/cpukit/score/cpu/nios2/nios2-isr-get-level.c
index f6a51cd..3867b13 100644
--- a/cpukit/score/cpu/nios2/nios2-isr-get-level.c
+++ b/cpukit/score/cpu/nios2/nios2-isr-get-level.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief CPU Provides Isr is in Progress
+ * @ingroup
+ */
+
 /*
  * Copyright (c) 2011 embedded brains GmbH
  *
diff --git a/cpukit/score/cpu/nios2/nios2-isr-is-in-progress.c b/cpukit/score/cpu/nios2/nios2-isr-is-in-progress.c
index b51404d..c6bc33d 100644
--- a/cpukit/score/cpu/nios2/nios2-isr-is-in-progress.c
+++ b/cpukit/score/cpu/nios2/nios2-isr-is-in-progress.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Returns the interrupt level of the executing thread.
+ * @ingroup
+ */
+
 /*
  * Copyright (c) 2011 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/score/cpu/nios2/nios2-mpu-add-region.c b/cpukit/score/cpu/nios2/nios2-mpu-add-region.c
index 1d7799c..7ec1a7e 100644
--- a/cpukit/score/cpu/nios2/nios2-mpu-add-region.c
+++ b/cpukit/score/cpu/nios2/nios2-mpu-add-region.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Adds a region according to region descriptor @a desc.
+ * @ingroup
+ */
+
 /*
  * Copyright (c) 2011 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/score/cpu/nios2/nios2-mpu-configuration.c b/cpukit/score/cpu/nios2/nios2-mpu-configuration.c
index 320e188..fd62b84 100644
--- a/cpukit/score/cpu/nios2/nios2-mpu-configuration.c
+++ b/cpukit/score/cpu/nios2/nios2-mpu-configuration.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Nios2 MPU Configuration
+ * @ingroup
+ */
+
 /*
  * Copyright (c) 2011 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/score/cpu/nios2/nios2-mpu-reset.c b/cpukit/score/cpu/nios2/nios2-mpu-reset.c
index 1f55d8c..f36787d 100644
--- a/cpukit/score/cpu/nios2/nios2-mpu-reset.c
+++ b/cpukit/score/cpu/nios2/nios2-mpu-reset.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Nios2 MPU Reset
+ * @ingroup
+ */
+
 /*
  * Copyright (c) 2011 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/score/cpu/nios2/rtems/score/cpu.h b/cpukit/score/cpu/nios2/rtems/score/cpu.h
index 68ab01d..6ff9439 100644
--- a/cpukit/score/cpu/nios2/rtems/score/cpu.h
+++ b/cpukit/score/cpu/nios2/rtems/score/cpu.h
@@ -39,6 +39,10 @@ extern "C" {
 
 #define CPU_INTERRUPT_MAXIMUM_VECTOR_NUMBER (CPU_INTERRUPT_NUMBER_OF_VECTORS - 1)
 
+/**
+ * @brief CPU Provides Isr is in Progress
+ *
+ */
 #define CPU_PROVIDES_ISR_IS_IN_PROGRESS TRUE
 
 #define CPU_HAS_HARDWARE_INTERRUPT_STACK FALSE
@@ -290,7 +294,7 @@ uint32_t _CPU_ISR_Get_level( void );
 
 /**
  * @brief Initializes the CPU context.
- *
+ *
  * The following steps are performed:
  *  - setting a starting address
  *  - preparing the stack
@@ -316,6 +320,10 @@ void _CPU_Context_Initialize(
 #define _CPU_Context_Restart_self( _the_context ) \
   _CPU_Context_restore( (_the_context) );
 
+/**
+ * @brief CPU Fatal Halt
+ *
+ */
 void _CPU_Fatal_halt( uint32_t _error ) RTEMS_COMPILER_NO_RETURN_ATTRIBUTE;
 
 void _CPU_Initialize( void );
diff --git a/cpukit/score/cpu/nios2/rtems/score/nios2-utility.h b/cpukit/score/cpu/nios2/rtems/score/nios2-utility.h
index 022990d..43d4ecb 100644
--- a/cpukit/score/cpu/nios2/rtems/score/nios2-utility.h
+++ b/cpukit/score/cpu/nios2/rtems/score/nios2-utility.h
@@ -323,6 +323,10 @@ typedef struct {
 
 void _Nios2_MPU_Set_configuration( const Nios2_MPU_Configuration *config );
 
+/**
+ * @brief Nios2 MPU Configuration
+ *
+ */
 const Nios2_MPU_Configuration *_Nios2_MPU_Get_configuration( void );
 
 typedef enum {
@@ -490,6 +494,9 @@ static inline void _Nios2_MPU_Restore( uint32_t config )
 
 uint32_t _Nios2_MPU_Disable_protected( void );
 
+/**
+ * @brief Nios2 MPU Reset
+ */
 void _Nios2_MPU_Reset( const Nios2_MPU_Configuration *config );
 
 #ifdef __cplusplus