Header File Doxygen Enhancement Task #1

20 files changed, 70 insertions, 51 deletions

diff --git a/cpukit/include/rtems/status-checks.h b/cpukit/include/rtems/status-checks.h
index ce23e25c14..631c9f40fa 100644
--- a/cpukit/include/rtems/status-checks.h
+++ b/cpukit/include/rtems/status-checks.h
@@ -1,7 +1,7 @@
 /**
  * @file
  *
- * @brief Header file for status checks.
+ * @brief Header File for Status Checks
  *
  * @warning Do not include this file in other header files.  Use it only in
  * source files.
diff --git a/cpukit/include/rtems/userenv.h b/cpukit/include/rtems/userenv.h
index 8cc7a7c39f..53ec42dcf6 100644
--- a/cpukit/include/rtems/userenv.h
+++ b/cpukit/include/rtems/userenv.h
@@ -2,6 +2,7 @@
  * @file
  *
  * @ingroup LibIOEnv
+ * @brief User Environment Support
  */
 
 /*
diff --git a/cpukit/libblock/include/rtems/bdbuf.h b/cpukit/libblock/include/rtems/bdbuf.h
index 7f1c13d7b0..197c20dfcf 100644
--- a/cpukit/libblock/include/rtems/bdbuf.h
+++ b/cpukit/libblock/include/rtems/bdbuf.h
@@ -2,8 +2,7 @@
  * @file
  *
  * @ingroup rtems_bdbuf
- *
- * Block device buffer management.
+ * @brief Block Device Buffer Management
  */
 
 /*
diff --git a/cpukit/libblock/include/rtems/ide_part_table.h b/cpukit/libblock/include/rtems/ide_part_table.h
index ea3dcb331d..3868a3dea7 100644
--- a/cpukit/libblock/include/rtems/ide_part_table.h
+++ b/cpukit/libblock/include/rtems/ide_part_table.h
@@ -1,7 +1,7 @@
 /**
- * @file rtems/ide_part_table.h
- *
- * Support for "MS-DOS-style" partition tables
+ * @file
+ * 
+ * @brief "MS-DOS-style" Partition Tables Support
  */
 
 /*
diff --git a/cpukit/libblock/include/rtems/ramdisk.h b/cpukit/libblock/include/rtems/ramdisk.h
index 690864ceea..aaa940b7c4 100644
--- a/cpukit/libblock/include/rtems/ramdisk.h
+++ b/cpukit/libblock/include/rtems/ramdisk.h
@@ -1,9 +1,7 @@
 /**
  * @file
  *
- * @ingroup rtems_ramdisk
- *
- * @brief RAM disk block device API.
+ * @brief RAM Disk Block Device API
  */
 
 /*
diff --git a/cpukit/libcsupport/include/rtems/libcsupport.h b/cpukit/libcsupport/include/rtems/libcsupport.h
index 2c498848b5..32ed8a8798 100644
--- a/cpukit/libcsupport/include/rtems/libcsupport.h
+++ b/cpukit/libcsupport/include/rtems/libcsupport.h
@@ -1,6 +1,8 @@
 /**
- * @file rtems/libcsupport.h
- *
+ * @file
+ * 
+ * @brief Standard C Library Support
+ * 
  * This include file contains the information regarding the
  * RTEMS specific support for the standard C library.
  */
diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h
index 6ef4b6ccb6..c8e91ded99 100644
--- a/cpukit/libcsupport/include/rtems/libio_.h
+++ b/cpukit/libcsupport/include/rtems/libio_.h
@@ -1,6 +1,8 @@
 /**
- * @file rtems/libio_.h
+ * @file
  *
+ * @brief LibIO Internal Interface
+ * 
  * This file is the libio internal interface.
  */
 
diff --git a/cpukit/libcsupport/include/vmeintr.h b/cpukit/libcsupport/include/vmeintr.h
index 7e88bd0965..4fdc8ac772 100644
--- a/cpukit/libcsupport/include/vmeintr.h
+++ b/cpukit/libcsupport/include/vmeintr.h
@@ -1,5 +1,7 @@
 /**
- * @file rtems/vmeintr.h
+ * @file
+ * 
+ * @brief VMEbus Interface Library
  *
  *  This file is the specification for the VMEbus interface library
  *  which should be provided by all BSPs for VMEbus Single Board
diff --git a/cpukit/libfs/src/devfs/devfs.h b/cpukit/libfs/src/devfs/devfs.h
index 2317b10852..0f5e248225 100644
--- a/cpukit/libfs/src/devfs/devfs.h
+++ b/cpukit/libfs/src/devfs/devfs.h
@@ -1,8 +1,10 @@
 /**
-*  @file  libfs/devfs/devfs.h
-*
-*  This include file contains all constants and structures associated
-*  with the 'device-only' filesystem.
+* @file 
+* 
+* @brief 'device-only' File System Support
+*  
+* This include file contains all constants and structures associated
+* with the 'device-only' filesystem.
 */
 
 #ifndef _RTEMS_DEVFS_H
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-shell.h b/cpukit/libfs/src/rfs/rtems-rfs-shell.h
index f4e56227b7..135290d3e9 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-shell.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-shell.h
@@ -1,17 +1,20 @@
-/*
- *  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
+ * @brief RTEMS File Systems Shell Commands
  *
  * RTEMS File Systems Shell commands provide a CLI interface to support and
- * development od the RFS file system.
+ * development of the RFS 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_SHELL_H_)
diff --git a/cpukit/libmisc/devnull/devnull.h b/cpukit/libmisc/devnull/devnull.h
index 84e1475471..61fa60a33a 100644
--- a/cpukit/libmisc/devnull/devnull.h
+++ b/cpukit/libmisc/devnull/devnull.h
@@ -1,6 +1,8 @@
 /**
- * @file rtems/devnull.h
+ * @file
  *
+ * @brief RTEMS /dev/null Device Driver
+ * 
  * This include file defines the interface to the RTEMS /dev/null
  * device driver.
  */
diff --git a/cpukit/libmisc/dumpbuf/dumpbuf.h b/cpukit/libmisc/dumpbuf/dumpbuf.h
index d03274a1bc..02e5304673 100644
--- a/cpukit/libmisc/dumpbuf/dumpbuf.h
+++ b/cpukit/libmisc/dumpbuf/dumpbuf.h
@@ -1,6 +1,8 @@
 /**
- * @file rtems/dumpbuf.h
+ * @file
  *
+ * @brief Print a Memory Buffer
+ * 
  * This file defines the interface to the RTEMS methods to print a
  * memory buffer in a style similar to many ROM monitors and debuggers.
  */
diff --git a/cpukit/libmisc/mouse/serial_mouse.h b/cpukit/libmisc/mouse/serial_mouse.h
index a84bf7f916..44d46338d7 100644
--- a/cpukit/libmisc/mouse/serial_mouse.h
+++ b/cpukit/libmisc/mouse/serial_mouse.h
@@ -1,13 +1,15 @@
 /**
- * @file rtems/serial_mouse.h
+ * @file
+ * 
+ * @brief Serial Mouse Driver
  *
- *  This file describes the Serial Mouse Driver for all boards.
- *  This driver assumes that the BSP or application will provide
- *  an implementation of the method bsp_get_serial_mouse_device()
- *  which tells the driver what serial port device to open() and
- *  what type of mouse is connected.
+ * This file describes the Serial Mouse Driver for all boards.
+ * This driver assumes that the BSP or application will provide
+ * an implementation of the method bsp_get_serial_mouse_device()
+ * which tells the driver what serial port device to open() and
+ * what type of mouse is connected.
  *
- *  This driver relies on the Mouse Parser Engine.
+ * This driver relies on the Mouse Parser Engine.
  */
 
 /*
diff --git a/cpukit/libmisc/untar/untar.h b/cpukit/libmisc/untar/untar.h
index 81cbd0e8ba..84b0efe62e 100644
--- a/cpukit/libmisc/untar/untar.h
+++ b/cpukit/libmisc/untar/untar.h
@@ -1,6 +1,8 @@
 /**
- * @file rtems/untar.h
+ * @file
  *
+ * @brief Untar an Image
+ * 
  * This file defines the interface to methods which can untar an image.
  */
 
diff --git a/cpukit/libnetworking/memory.h b/cpukit/libnetworking/memory.h
index 99fdb5e1e4..ee8bd4089e 100644
--- a/cpukit/libnetworking/memory.h
+++ b/cpukit/libnetworking/memory.h
@@ -1,7 +1,7 @@
 /**
- * @file memory.h
+ * @file
  *
- * Dummy include file for FreeBSD routines
+ * @brief Dummy Include File for FreeBSD Routines
  */
 
 #include <string.h>
diff --git a/cpukit/posix/include/aio.h b/cpukit/posix/include/aio.h
index f4f824ab69..3ad7a400e6 100644
--- a/cpukit/posix/include/aio.h
+++ b/cpukit/posix/include/aio.h
@@ -1,6 +1,8 @@
 /**
- * @file aio.h
+ * @file
  *
+ * @brief POSIX Asynchronous Input and Output
+ * 
  * This file contains the definitions related to POSIX Asynchronous
  * Input and Output,
  */
diff --git a/cpukit/posix/include/mqueue.h b/cpukit/posix/include/mqueue.h
index a35d94ccc4..0f937f5f2b 100644
--- a/cpukit/posix/include/mqueue.h
+++ b/cpukit/posix/include/mqueue.h
@@ -1,6 +1,8 @@
 /**
- * @file mqueue.h
+ * @file
  *
+ * @brief POSIX Message Queues
+ * 
  * This file contains the definitions related to POSIX Message Queues.
  * 
  * The structure of the routines is identical to that of POSIX
diff --git a/cpukit/sapi/include/rtems/io.h b/cpukit/sapi/include/rtems/io.h
index 2a268fa51e..8f02a34e2c 100644
--- a/cpukit/sapi/include/rtems/io.h
+++ b/cpukit/sapi/include/rtems/io.h
@@ -1,9 +1,7 @@
 /**
  * @file
  *
- * @ingroup ClassicIO
- *
- * @brief Classic Input/Output Manager API.
+ * @brief Classic Input/Output Manager API
  * 
  * This file emulates the old Classic RTEMS IO manager directives
  * which register and lookup names using the in-memory filesystem.
diff --git a/cpukit/sapi/include/rtems/timespec.h b/cpukit/sapi/include/rtems/timespec.h
index d502de3eac..fcea746445 100644
--- a/cpukit/sapi/include/rtems/timespec.h
+++ b/cpukit/sapi/include/rtems/timespec.h
@@ -1,11 +1,9 @@
 /**
- *  @file  rtems/sapi/timespec.h
+ * @file
  *
- *  @ingroup 
+ * @brief Timespec API
  *
- *  @brief Timespec API
- *
- *  This include file contains API for manipulating timespecs.
+ * This include file contains API for manipulating timespecs.
  */
 
 /*
diff --git a/cpukit/score/include/rtems/system.h b/cpukit/score/include/rtems/system.h
index 46f080b46a..96318f7c3b 100644
--- a/cpukit/score/include/rtems/system.h
+++ b/cpukit/score/include/rtems/system.h
@@ -1,9 +1,11 @@
 /**
- *  @file  rtems/system.h
+ * @file
+ * 
+ * @brief Information Included in Every Function in the Executive
  *
- *  This include file contains information that is included in every
- *  function in the executive.  This must be the first include file
- *  included in all internal RTEMS files.
+ * This include file contains information that is included in every
+ * function in the executive.  This must be the first include file
+ * included in all internal RTEMS files.
  */
 
 /*