[1/1] Header File Doxygen Enhancement Task #5

[Cynthia Rempel]

Student: Ayush Awasthi
Email: kolaveridi87 at gmail.com
Please commit this patch
Thanks!

diff --git a/cpukit/score/cpu/sparc/rtems/score/types.h b/cpukit/score/cpu/sparc/rtems/score/types.h
index a8e56b7..49ce2a6 100644
--- a/cpukit/score/cpu/sparc/rtems/score/types.h
+++ b/cpukit/score/cpu/sparc/rtems/score/types.h
@@ -1,8 +1,8 @@
 /**
  * @file rtems/score/types.h
  *
+ * @ingroup Score
+ * @brief Priority Bit Map Type
  *
  * This include file contains type definitions pertaining to the SPARC processor family.
  */
 
 /*
diff --git a/cpukit/score/include/rtems/score/basedefs.h b/cpukit/score/include/rtems/score/basedefs.h
index e91467d..6b4e3f2 100644
--- a/cpukit/score/include/rtems/score/basedefs.h
+++ b/cpukit/score/include/rtems/score/basedefs.h
@@ -2,7 +2,6 @@
 /**
  * @file rtems/score/basedefs.h
  * 
+ * @ingroup Score
+ * @brief Basic definitions.
  */
 
diff --git a/cpukit/score/include/rtems/score/bitfield.h b/cpukit/score/include/rtems/score/bitfield.h
index cfb9bf8..2d7ef6d 100644
--- a/cpukit/score/include/rtems/score/bitfield.h
+++ b/cpukit/score/include/rtems/score/bitfield.h
@@ -1,7 +1,8 @@
 /**
  * @file rtems/score/bitfield.h
  *
+ * @ingroup Score
- *  This include file contains all bit field manipulation routines.
+ * @brief This include file contains all bit field manipulation routines
  */
 
 /*
diff --git a/cpukit/score/include/rtems/score/copyrt.h b/cpukit/score/include/rtems/score/copyrt.h
index 87e6520..379c2b1 100644
--- a/cpukit/score/include/rtems/score/copyrt.h
+++ b/cpukit/score/include/rtems/score/copyrt.h
@@ -1,8 +1,8 @@
 /**
  * @file rtems/score/copyrt.h
  *
+ * @ingroup Score
- *  This include file contains the copyright notice for RTEMS
- *  which is included in every binary copy of the executive.
+ * @brief This is the copyright string for RTEMS.
  *
+ * This include file contains the copyright notice for RTEMS
+ * which is included in every binary copy of the executive.
  */
 
 /*
diff --git a/cpukit/score/include/rtems/score/coremsg.h b/cpukit/score/include/rtems/score/coremsg.h
index 0f468c8..148ced6 100644
--- a/cpukit/score/include/rtems/score/coremsg.h
+++ b/cpukit/score/include/rtems/score/coremsg.h
@@ -1,8 +1,8 @@
 /**
  * @file rtems/score/coremsg.h
  *
+ * @ingroup Score 
- *  This include file contains all the constants and structures associated
- *  with the Message queue Handler.
+ * @brief Initialize a Message Queue.
  * 
+ * This include file contains all the constants and structures associated
+ * with the Message queue Handler.
  */
 
 /*
diff --git a/cpukit/score/include/rtems/score/coremutex.h b/cpukit/score/include/rtems/score/coremutex.h
index 9c0fce3..cbbf5d5 100644
--- a/cpukit/score/include/rtems/score/coremutex.h
+++ b/cpukit/score/include/rtems/score/coremutex.h
@@ -1,10 +1,8 @@
 /**
  * @file rtems/score/coremutex.h
  *
+ * @ingroup Score
- *  This include file contains all the constants and structures associated
- *  with the Mutex Handler.  A mutex is an enhanced version of the standard
- *  Dijkstra binary semaphore used to provide synchronization and mutual
- *  exclusion capabilities.
+ * @brief Initialize a Core Mutex. 
  *  
+ * This include file contains all the constants and structures associated 
+ * with the Mutex Handler.  A mutex is an enhanced version of the standard
+ * Dijkstra binary semaphore usedto provide synchronization and mutual 
+ * exclusion capabilities.
  */
 
 /*
@@ -19,12 +17,12 @@
 #ifndef _RTEMS_SCORE_COREMUTEX_H
 #define _RTEMS_SCORE_COREMUTEX_H
 /**
+ * @ingroup Score
- *  This handler encapsulates functionality which provides the foundation
- *  Mutex services used in all of the APIs supported by RTEMS.
+ * @brief This handler encapsulates functionality which provides the foundation
+ * Mutex services used in all of the APIs supported by RTEMS.
  */
 /**@{*/
 
diff --git a/cpukit/score/include/rtems/score/corerwlock.h b/cpukit/score/include/rtems/score/corerwlock.h
index 3b70d80..002cf36 100644
--- a/cpukit/score/include/rtems/score/corerwlock.h
+++ b/cpukit/score/include/rtems/score/corerwlock.h
@@ -1,8 +1,9 @@
 /**
  * @file rtems/score/corerwlock.h
  *
+ * @ingroup Score
- *  This include file contains all the constants and structures associated
- *  with the RWLock Handler.
+ * @brief This include file contains all the constants and structures associated
+ * with the RWLock Handler.
  */
 
 /*
@@ -18,12 +19,11 @@
 #define _RTEMS_SCORE_CORERWLOCK_H
 /**
- *  This handler encapsulates functionality which provides the foundation
- *  RWLock services used in all of the APIs supported by RTEMS.
+ * @brief This handler encapsulates functionality which provides the 
+ * foundation RWLock services used in all of the APIs supported by RTEMS.
  */
 /**@{*/
 
diff --git a/cpukit/score/include/rtems/score/heap.h b/cpukit/score/include/rtems/score/heap.h
index f3d259d..a2953cf 100644
--- a/cpukit/score/include/rtems/score/heap.h
+++ b/cpukit/score/include/rtems/score/heap.h
@@ -2,7 +2,6 @@
 /**
  * @file rtems/score/heap.h
  *
+ * @ingroup ScoreHeap
+ * @brief Heap Handler API.
  */
 
@@ -33,7 +32,6 @@ extern "C" {
+ * @defgroup ScoreHeap Heap Handler
  *
+ * @brief The Heap Handler provides a heap.
  *
+ * A heap is a doubly linked list of variable size blocks which are allocated
  */
diff --git a/cpukit/score/include/rtems/score/interr.h b/cpukit/score/include/rtems/score/interr.h
index 522e157..1efeeb6 100644
--- a/cpukit/score/include/rtems/score/interr.h
+++ b/cpukit/score/include/rtems/score/interr.h
@@ -1,8 +1,10 @@
 /**
  * @file rtems/score/interr.h
  * 
+ * @ingroup Score
- *  This include file contains constants and prototypes related
- *  to the Internal Error Handler.
+ * @brief Initiates system termination
  *
+ * This include file contains constants and prototypes related
+ * to the Internal Error Handler.
  */
 
 /*
diff --git a/cpukit/score/include/rtems/score/percpu.h b/cpukit/score/include/rtems/score/percpu.h
index 3e4712d..ff3f1fd 100644
--- a/cpukit/score/include/rtems/score/percpu.h
+++ b/cpukit/score/include/rtems/score/percpu.h
@@ -1,8 +1,8 @@
 /**
  * @file rtems/score/percpu.h
  *
+ * @ingroup Score
- *  This include file defines the per CPU information required
- *  by RTEMS.
+ * @brief This include file defines the per CPU information required by RTEMS
  */
 
 /*
@@ -36,14 +36,13 @@
 #endif
 /**
- *  @defgroup PerCPU RTEMS Per CPU Information
+ * @defgroup PerCPU RTEMS Per CPU Information
  *
+ * @ingroup Score
- *  This defines the per CPU state information required by RTEMS
- *  and the BSP.  In an SMP configuration, there will be multiple
- *  instances of this data structure -- one per CPU -- and the
- *  current CPU number will be used as the index.
+ * @brief This defines the per CPU state information required by RTEMS
+ * and the BSP.  In an SMP configuration, there will be multiple
+ * instances of this data structure -- one per CPU -- and the
+ * current CPU number will be used as the index.
  */
 
 /**@{*/
diff --git a/cpukit/score/include/rtems/score/rbtree.h b/cpukit/score/include/rtems/score/rbtree.h
index 5a03d7c..c50c6de 100644
--- a/cpukit/score/include/rtems/score/rbtree.h
+++ b/cpukit/score/include/rtems/score/rbtree.h
@@ -1,8 +1,8 @@
 /**
  * @file rtems/score/rbtree.h
  *
+ * @ingroup Score
- *  This include file contains all the constants and structures associated
- *  with the Red-Black Tree Handler.
+ * @brief This include file contains all the constants and structures 
+ * associated with the Red-Black Tree Handler
  */
 
 /*
@@ -22,7 +22,6 @@
+ * @defgroup ScoreRBTree Red-Black Tree Handler
+ * @brief The Red-Black Tree Handler is used to manage sets of entities. This
+ * handler provides two data structures. The rbtree Node data structure is 
+ * included as the first part of every data structure that will be placed on
  */

 */
diff --git a/cpukit/score/include/rtems/score/schedulercbs.h b/cpukit/score/include/rtems/score/schedulercbs.h
index d0bc5ee..dbaf622 100644
--- a/cpukit/score/include/rtems/score/schedulercbs.h
+++ b/cpukit/score/include/rtems/score/schedulercbs.h
@@ -1,8 +1,9 @@
 /**
  * @file rtems/score/schedulercbs
  *
+ * @ingroup Score
- *  @brief This include file contains all the constants and structures 
- *  associated with the manipulation of threads for the CBS scheduler.
+ * @brief This include file contains all the constants and structures 
+ * associated with the manipulation of threads for the CBS scheduler.
  */
 
 /*
@@ -31,7 +32,7 @@ extern "C" {
 #endif
 /**
- *  @addtogroup ScoreScheduler
+ * @defgroup ScoreScheduler
  *
  */
 /**@{*/
diff --git a/cpukit/score/include/rtems/score/schedulerpriority.h b/cpukit/score/include/rtems/score/schedulerpriority.h
index 3432937..003d092 100644
--- a/cpukit/score/include/rtems/score/schedulerpriority.h
+++ b/cpukit/score/include/rtems/score/schedulerpriority.h
@@ -1,6 +1,8 @@
 /**
  * @file rtems/score/schedulerpriority.h
  *
+ * ingroup Score  
+ * @brief Initialize Scheduler Priority
  *
+ * This include file contains all the constants and structures associated
+ * with the manipulation of threads for the priority-based scheduler.
  */
diff --git a/cpukit/score/include/rtems/score/thread.h b/cpukit/score/include/rtems/score/thread.h
index 623b562..9e2c63c 100644
--- a/cpukit/score/include/rtems/score/thread.h
+++ b/cpukit/score/include/rtems/score/thread.h
@@ -1,8 +1,9 @@
 /**
  * @file rtems/score/thread.h
  *
+ * @ingroup Score
- *  This include file contains all constants and structures associated
- *  with the thread control block.
+ * @brief This include file contains all constants and structures associated
+ * with the thread control block.
  */
 
 /*
diff --git a/cpukit/score/include/rtems/score/threadq.h b/cpukit/score/include/rtems/score/threadq.h
index a2653b3..112f8bc 100644
--- a/cpukit/score/include/rtems/score/threadq.h
+++ b/cpukit/score/include/rtems/score/threadq.h
@@ -1,9 +1,9 @@
 /**
  * @file rtems/score/threadq.h
  *
+ * @ingroup Score
- *  This include file contains all the constants and structures associated
- *  with the manipulation of objects.
+ * @brief Thread Queue Initialize
  *
+ * This include file contains all the constants and structures associated
+ * with the manipulation of objects.
  /**
 
 /*
  *  COPYRIGHT (c) 1989-2009.
@@ -18,12 +18,10 @@
 #define _RTEMS_SCORE_THREADQ_H
 
 /**
- *  @defgroup ScoreThreadQ Thread Queue Handler
+ * @defgroup ScoreThreadQ Thread Queue Handler
  */
 /**@{*/
 
diff --git a/cpukit/score/include/rtems/score/timestamp.h b/cpukit/score/include/rtems/score/timestamp.h
index 951c374..b50a8cc 100644
--- a/cpukit/score/include/rtems/score/timestamp.h
+++ b/cpukit/score/include/rtems/score/timestamp.h
@@ -1,6 +1,6 @@
 /**
  * @file rtems/score/timestamp.h
  *
+ * ingroup Source
- *  This include file contains helpers for manipulating timestamps.
+ * @brief This include file contains helpers for manipulating timestamps. 
  *
+ * This include file contains all the constants and structures
+ * associated with the manipulation of objects.
  */

 /*
diff --git a/cpukit/score/include/rtems/score/tod.h b/cpukit/score/include/rtems/score/tod.h
index eb743b7..2b7078b 100644
--- a/cpukit/score/include/rtems/score/tod.h
+++ b/cpukit/score/include/rtems/score/tod.h
@@ -1,8 +1,9 @@
 /**
  * @file rtems/score/tod.h
  *
+ * @ingroup Score
- *  This include file contains all the constants and structures 
- *  associated with the Time of Day Handler.
+ * @brief This include file contains all the constants and structures
+ * associated with the Time of Day Handler
  */
 
 /*
diff --git a/cpukit/score/include/rtems/score/userext.h b/cpukit/score/include/rtems/score/userext.h
index 6071d7a..3bde4cf 100644
--- a/cpukit/score/include/rtems/score/userext.h
+++ b/cpukit/score/include/rtems/score/userext.h
@@ -2,7 +2,6 @@
 /**
  * @file rtems/score/userext.h
  *
+ * @ingroup ScoreUserExt
+ * @brief User Extension Handler API.
  */

 /*
diff --git a/cpukit/score/include/rtems/score/userextimpl.h b/cpukit/score/include/rtems/score/userextimpl.h
index 7a89d9a..f169b8b 100644
--- a/cpukit/score/include/rtems/score/userextimpl.h
+++ b/cpukit/score/include/rtems/score/userextimpl.h
@@ -2,7 +2,6 @@
 /**
  * @file rtems/score/userextimpl.h
  *
+ * @ingroup ScoreUserExt
+ * @brief User Extension Handler API.
  *
+ * List of active extensions.
  */

 /*