misc: Header File Doxygen Enhancement Task #3

http://www.google-melange.com/gci/task/view/google/gci2012/8006220

20 files changed, 169 insertions, 109 deletions

diff --git a/cpukit/libcsupport/include/rtems/deviceio.h b/cpukit/libcsupport/include/rtems/deviceio.h
index 637eef4f6c..b832942750 100644
--- a/cpukit/libcsupport/include/rtems/deviceio.h
+++ b/cpukit/libcsupport/include/rtems/deviceio.h
@@ -1,5 +1,7 @@
 /**
  * @file rtems/deviceio.h
+ *
+ * @brief Map Operations on IMFS Device Nodes to the RTEMS Classic API IO Manager
  */
 
 /*
diff --git a/cpukit/libcsupport/include/zilog/z8530.h b/cpukit/libcsupport/include/zilog/z8530.h
index e4495fc1a5..d11698de50 100644
--- a/cpukit/libcsupport/include/zilog/z8530.h
+++ b/cpukit/libcsupport/include/zilog/z8530.h
@@ -1,6 +1,8 @@
 /**
  * @file rtems/zilog/z8530.h
  *
+ * @brief Information Related to a Zilog Z8530 SCC Chip
+ *
  *  This include file defines information related to a Zilog Z8530
  *  SCC Chip.  It is a IO mapped part.
  */
diff --git a/cpukit/libcsupport/include/zilog/z8536.h b/cpukit/libcsupport/include/zilog/z8536.h
index accf500fd7..326e75531e 100644
--- a/cpukit/libcsupport/include/zilog/z8536.h
+++ b/cpukit/libcsupport/include/zilog/z8536.h
@@ -1,6 +1,8 @@
 /**
  * @file rtems/zilog/z8536.h
  *
+ * @brief Information Related to a Zilog Z8536 Counter/Timer/IO Chip
+ *
  * This include file defines information related to a Zilog Z8536
  * Counter/Timer/IO Chip.  It is a IO mapped part.
  *
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h b/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h
index 908de55ede..01d4f0f28c 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File Systems Bitmap Routines
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File Systems Bitmap Routines.
@@ -18,6 +13,15 @@
  * search bits can checked in a test.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
+
 #if !defined (_RTEMS_RFS_BITMAPS_H_)
 #define _RTEMS_RFS_BITMAPS_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h b/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h
index 6355e2f190..b0de7c1846 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-block-pos.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File Systems Block Position and Size Management
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File Systems Block Position and Size Management.
@@ -23,6 +18,14 @@
  * which set of rules are in use and the reason for this file.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
 #if !defined (_RTEMS_RFS_BLOCK_POS_H_)
 #define _RTEMS_RFS_BLOCK_POS_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-block.h b/cpukit/libfs/src/rfs/rtems-rfs-block.h
index dc7b4652d0..c93cb20b24 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-block.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-block.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File Systems Block Management
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File Systems Block Management.
@@ -15,6 +10,15 @@
  * These functions manage the blocks used in the file system.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
+
 #if !defined (_RTEMS_RFS_BLOCK_H_)
 #define _RTEMS_RFS_BLOCK_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-buffer.h b/cpukit/libfs/src/rfs/rtems-rfs-buffer.h
index 335274a969..c6b1f05c53 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-buffer.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-buffer.h
@@ -1,20 +1,22 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
  * @ingroup rtems-rfs
  *
- * RTEMS File Systems Buffer Management.
+ * @brief Maps Blocks to the Media Interface Layers
  *
  * These functions map blocks to the media interface layers.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
+
 #if !defined (_RTEMS_RFS_BUFFER_H_)
 #define _RTEMS_RFS_BUFFER_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-data.h b/cpukit/libfs/src/rfs/rtems-rfs-data.h
index 60d1e6b250..0e20423adc 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-data.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-data.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File System Data
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File System Data.
@@ -18,6 +13,15 @@
  * @todo Make direct access on matching byte ordered targets.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
+
 #if !defined (_RTEMS_RFS_DATA_H_)
 #define _RTEMS_RFS_DATA_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h b/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h
index 53244d4d87..f7908d8716 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h
@@ -1,19 +1,22 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief Provides a 32bit Hash of a String used to Search a Directory
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File Systems Directory Hash provides a 32bit hash of a string. This is
  * used to search a directory.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
 #if !defined (_RTEMS_RFS_DIR_HASH_H_)
 #define _RTEMS_RFS_DIR_HAS_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-dir.h b/cpukit/libfs/src/rfs/rtems-rfs-dir.h
index 76414f827e..50c89eccc5 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-dir.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-dir.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File System Directory Support
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File System Directory Support
@@ -15,6 +10,14 @@
  * This file provides the directory support functions.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
 #if !defined (_RTEMS_RFS_DIR_H_)
 #define _RTEMS_RFS_DIR_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h b/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h
index 1a707d97d9..ae45acf55e 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h
@@ -1,18 +1,22 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File Systems Data forward decl
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File Systems Data forward decl.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
+
 #if !defined (_RTEMS_RFS_FILE_SYSTEM_FWD_H_)
 #define _RTEMS_RFS_FILE_SYSTEM_FWD_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-file-system.h b/cpukit/libfs/src/rfs/rtems-rfs-file-system.h
index 9d54f64a1f..c1f3dd7465 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-file-system.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-file-system.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File System Data
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File System Data
@@ -15,6 +10,14 @@
  * This file defines the file system data.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
 #if !defined (_RTEMS_RFS_FILE_SYSTEM_H_)
 #define _RTEMS_RFS_FILE_SYSTEM_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-file.h b/cpukit/libfs/src/rfs/rtems-rfs-file.h
index 9251fe439f..f39f02a985 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-file.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-file.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File System File Support
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File System File Support
@@ -15,6 +10,14 @@
  * This file provides the support functions.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
 #if !defined (_RTEMS_RFS_FILE_H_)
 #define _RTEMS_RFS_FILE_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-group.h b/cpukit/libfs/src/rfs/rtems-rfs-group.h
index adec1c26d8..257eb49f34 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-group.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-group.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File Systems Group Management
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File Systems Group Management.
@@ -15,6 +10,15 @@
  * These functions manage the groups used in the file system.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
+
 #if !defined (_RTEMS_RFS_GROUP_H_)
 #define _RTEMS_RFS_GROUP_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-inode.h b/cpukit/libfs/src/rfs/rtems-rfs-inode.h
index a18940e23d..a26232fdc3 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-inode.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-inode.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File System Information Node
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File System Information Node.
@@ -15,6 +10,15 @@
  * The information nodes hold the data about all nodes in the file system.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
+
 #if !defined (_RTEMS_RFS_INODE_H_)
 #define _RTEMS_RFS_INODE_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-link.h b/cpukit/libfs/src/rfs/rtems-rfs-link.h
index e7fc3b1206..0f473f2200 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-link.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-link.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File System Link Support
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File System Link Support
@@ -15,6 +10,15 @@
  * This file provides the link support functions.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
+
 #if !defined (_RTEMS_RFS_LINK_H_)
 #define _RTEMS_RFS_LINK_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-mutex.h b/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
index 1b5dde812c..ac04aeea1a 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief RTEMS File System Mutex
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File System Mutex.
@@ -16,6 +11,14 @@
  * is designed to be run on host operating systems.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
 #if !defined (_RTEMS_RFS_MUTEX_H_)
 #define _RTEMS_RFS_MUTEX_H_
 
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-trace.h b/cpukit/libfs/src/rfs/rtems-rfs-trace.h
index 6a4ca7bafa..09273a5939 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-trace.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-trace.h
@@ -1,13 +1,8 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
- */
 /**
  * @file
  *
+ * @brief Manages the Trace and Debugging Features of the RTEMS RFS File System
+ *
  * @ingroup rtems-rfs
  *
  * RTEMS File Systems Trace manages the trace and debugging features of the
@@ -15,6 +10,15 @@
  * removed from the target code for small footprint systems.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ */
+
+
 #if !defined (_RTEMS_RFS_TRACE_H_)
 #define _RTEMS_RFS_TRACE_H_
 
diff --git a/cpukit/sapi/include/rtems/rbheap.h b/cpukit/sapi/include/rtems/rbheap.h
index 5481e8954f..39bbc69a3f 100644
--- a/cpukit/sapi/include/rtems/rbheap.h
+++ b/cpukit/sapi/include/rtems/rbheap.h
@@ -1,9 +1,9 @@
 /**
  * @file
  *
- * @ingroup RBHeap
+ * @brief Red-Black Tree Heap API
  *
- * @brief Red-Black Tree Heap API.
+ * @ingroup RBHeap
  */
 
 /*
diff --git a/cpukit/score/include/rtems/debug.h b/cpukit/score/include/rtems/debug.h
index 4087e4ae94..101aea1478 100644
--- a/cpukit/score/include/rtems/debug.h
+++ b/cpukit/score/include/rtems/debug.h
@@ -1,6 +1,8 @@
 /**
  *  @file  rtems/debug.h
  *
+ *  @brief Information Related to the Debug Support Within RTEMS
+ *
  *  This include file contains the information pertaining to the debug
  *  support within RTEMS.  It is currently cast in the form of a
  *  Manager since it is externally accessible.
@@ -65,7 +67,7 @@ void rtems_debug_disable(
 
 /**
  *  @brief Check if Debug is Enabled
- *  
+ *
  *  This routine returns TRUE if the requested debug level is
  *  enabled, and FALSE otherwise.
  */