2011-06-24 Joel Sherrill <joel.sherrill@oarcorp.com>

	* include/rtems/bspIo.h, include/rtems/concat.h,
	include/rtems/endian.h, include/rtems/fs.h, include/rtems/irq.h,
	include/rtems/pci.h, include/rtems/userenv.h,
	libblock/include/rtems/flashdisk.h,
	libblock/include/rtems/nvdisk-sram.h,
	libblock/include/rtems/nvdisk.h, libcsupport/include/clockdrv.h,
	libcsupport/include/console.h, libcsupport/include/iosupp.h,
	libcsupport/include/spurious.h,
	libcsupport/include/motorola/mc68230.h,
	libcsupport/include/rtems/assoc.h, libcsupport/include/rtems/error.h,
	libcsupport/include/rtems/framebuffer.h,
	libcsupport/include/rtems/gxx_wrappers.h,
	libcsupport/include/rtems/libcsupport.h,
	libcsupport/include/rtems/libio_.h,
	libcsupport/include/rtems/malloc.h,
	libcsupport/include/rtems/termiostypes.h,
	libcsupport/include/sys/statvfs.h, libcsupport/include/sys/termios.h,
	libcsupport/include/sys/utsname.h, libcsupport/include/zilog/z8036.h,
	libcsupport/include/zilog/z8530.h, libcsupport/include/zilog/z8536.h,
	libfs/src/imfs/imfs.h, libfs/src/pipe/pipe.h,
	libmisc/capture/capture-cli.h, libmisc/capture/capture.h,
	libmisc/cpuuse/cpuuse.h, libmisc/devnull/devnull.h,
	libmisc/devnull/devzero.h, libmisc/dumpbuf/dumpbuf.h,
	libmisc/fb/fb.h, libmisc/fb/mw_uid.h, libmisc/mouse/mouse_parser.h,
	libmisc/shell/shellconfig.h, libmisc/stringto/stringto.h,
	libmisc/untar/untar.h, libnetworking/memory.h, posix/include/aio.h,
	posix/include/mqueue.h, posix/include/semaphore.h,
	posix/include/rtems/posix/aio_misc.h,
	posix/include/rtems/posix/barrier.h,
	posix/include/rtems/posix/cond.h, posix/include/rtems/posix/config.h,
	posix/include/rtems/posix/key.h, posix/include/rtems/posix/mqueue.h,
	posix/include/rtems/posix/mutex.h,
	posix/include/rtems/posix/posixapi.h,
	posix/include/rtems/posix/priority.h,
	posix/include/rtems/posix/psignal.h,
	posix/include/rtems/posix/pthread.h,
	posix/include/rtems/posix/ptimer.h,
	posix/include/rtems/posix/rwlock.h,
	posix/include/rtems/posix/semaphore.h,
	posix/include/rtems/posix/sigset.h,
	posix/include/rtems/posix/spinlock.h,
	posix/include/rtems/posix/threadsup.h,
	posix/include/rtems/posix/time.h, posix/include/rtems/posix/timer.h,
	posix/inline/rtems/posix/barrier.inl,
	posix/inline/rtems/posix/cond.inl,
	posix/inline/rtems/posix/mqueue.inl,
	posix/inline/rtems/posix/mutex.inl,
	posix/inline/rtems/posix/priority.inl,
	posix/inline/rtems/posix/pthread.inl,
	posix/inline/rtems/posix/rwlock.inl,
	posix/inline/rtems/posix/semaphore.inl,
	posix/inline/rtems/posix/spinlock.inl,
	posix/inline/rtems/posix/timer.inl, rtems/mainpage.h,
	rtems/include/rtems/rtems/barrier.h,
	rtems/include/rtems/rtems/object.h,
	rtems/include/rtems/rtems/timer.h,
	rtems/inline/rtems/rtems/barrier.inl,
	rtems/inline/rtems/rtems/timer.inl,
	rtems/src/semtranslatereturncode.c, sapi/include/rtems/config.h,
	sapi/include/rtems/fatal.h, sapi/include/rtems/mptables.h,
	score/include/rtems/score/object.h,
	score/include/rtems/score/priority.h,
	score/inline/rtems/score/object.inl,
	score/inline/rtems/score/priority.inl: Add @file Doxygen directives
	and descriptions to files which originated with RTEMS. This improves
	the file list page generated by Doxygen.

19 files changed, 96 insertions, 76 deletions

diff --git a/cpukit/libcsupport/include/clockdrv.h b/cpukit/libcsupport/include/clockdrv.h
index d0eb55e9f6..e10cb76465 100644
--- a/cpukit/libcsupport/include/clockdrv.h
+++ b/cpukit/libcsupport/include/clockdrv.h
@@ -1,12 +1,11 @@
 /**
  * @file rtems/clockdrv.h
+ *
+ * This file describes the Clock Driver for all boards.
  */
 
-/*  clock.h
- *
- *  This file describes the Clock Driver for all boards.
- *
- *  COPYRIGHT (c) 1989-1999.
+/*
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/console.h b/cpukit/libcsupport/include/console.h
index 0a2d258887..c055e1076c 100644
--- a/cpukit/libcsupport/include/console.h
+++ b/cpukit/libcsupport/include/console.h
@@ -1,13 +1,12 @@
 /**
  * @file rtems/console.h
+ *
+ * This file describes the Console Device Driver for all boards.
+ * This driver provides support for the standard C Library.
  */
 
-/*  console.h
- *
- *  This file describes the Console Device Driver for all boards.
- *  This driver provides support for the standard C Library.
- *
- *  COPYRIGHT (c) 1989-1999.
+/*
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/iosupp.h b/cpukit/libcsupport/include/iosupp.h
index cd2ff02e06..67cb86f976 100644
--- a/cpukit/libcsupport/include/iosupp.h
+++ b/cpukit/libcsupport/include/iosupp.h
@@ -1,9 +1,11 @@
 /**
  * @file rtems/iosupp.h
+ *
+ * This include file defines some special characters of interest.
  */
 
 /*
- *  COPYRIGHT (c) 1989-1999.
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/motorola/mc68230.h b/cpukit/libcsupport/include/motorola/mc68230.h
index d993a150fd..125269aa99 100644
--- a/cpukit/libcsupport/include/motorola/mc68230.h
+++ b/cpukit/libcsupport/include/motorola/mc68230.h
@@ -1,17 +1,17 @@
 /**
  * @file rtems/motorola/mc68230.h
+ *
+ * Low level support code for the Motorola 68230 Parallel
+ * Interface/Timer (PIT)
  */
 
 /*
- * mc68230.h -- Low level support code for the Motorola 68230 Parallel
- *              Interface/Timer (PIT)
- *
  * Modified by Doug McBride, Colorado Space Grant College
  *
  * Format taken partly from RTEMS code and mostly from Motorola IDP user's
  * manual.  RTEMS copyright information below.
  *
- *  COPYRIGHT (c) 1989-1999.
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h
index 5b72b8d086..c6a8e1fc32 100644
--- a/cpukit/libcsupport/include/rtems/assoc.h
+++ b/cpukit/libcsupport/include/rtems/assoc.h
@@ -1,13 +1,11 @@
 /**
  * @file rtems/assoc.h
+ *
+ * RTEMS associativity routines.  Mainly used to convert a value from
+ * one space to another (eg: our errno's to host errno's and vice-versa)
  */
 
 /*
- *
- *  Rtems associativity routines.  Mainly used to convert a value from
- *  one space to another (eg: our errno's to host errno's and v.v)
- *
- *
  *  $Id$
  */
 
diff --git a/cpukit/libcsupport/include/rtems/error.h b/cpukit/libcsupport/include/rtems/error.h
index 6c589e8e94..a4360028cf 100644
--- a/cpukit/libcsupport/include/rtems/error.h
+++ b/cpukit/libcsupport/include/rtems/error.h
@@ -1,10 +1,10 @@
 /**
  * @file rtems/error.h
+ *
+ * Defines and externs for rtems error reporting
  */
 
 /*
- *  Defines and externs for rtems error reporting
- *
  *  $Id$
  */
 
diff --git a/cpukit/libcsupport/include/rtems/framebuffer.h b/cpukit/libcsupport/include/rtems/framebuffer.h
index a300716c58..1b6127e3e5 100644
--- a/cpukit/libcsupport/include/rtems/framebuffer.h
+++ b/cpukit/libcsupport/include/rtems/framebuffer.h
@@ -1,11 +1,11 @@
 /**
  * @file rtems/framebuffer.h
+ *
+ * This file describes the Frame Buffer Device Driver for all boards.
  */
 
 /*
- *  This file describes the Frame Buffer Device Driver for all boards.
- *
- *  COPYRIGHT (c) 1989-2009.
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/rtems/gxx_wrappers.h b/cpukit/libcsupport/include/rtems/gxx_wrappers.h
index d4d4aae799..e2da74d4cb 100755
--- a/cpukit/libcsupport/include/rtems/gxx_wrappers.h
+++ b/cpukit/libcsupport/include/rtems/gxx_wrappers.h
@@ -1,6 +1,10 @@
-/*
- *  RTEMS threads compatibility routines for libgcc2.
+/**
+ * @file rtems/gxx_wrappers.h
  *
+ * RTEMS threads compatibility routines for libgcc2.
+ */
+
+/*
  *  by: Rosimildo da Silva (rdasilva@connecttel.com)
  *
  *  Used ideas from:
diff --git a/cpukit/libcsupport/include/rtems/libcsupport.h b/cpukit/libcsupport/include/rtems/libcsupport.h
index 9dfcf851fe..21a3939f6c 100644
--- a/cpukit/libcsupport/include/rtems/libcsupport.h
+++ b/cpukit/libcsupport/include/rtems/libcsupport.h
@@ -1,13 +1,12 @@
 /**
  * @file rtems/libcsupport.h
+ *
+ * This include file contains the information regarding the
+ * RTEMS specific support for the standard C library.
  */
 
-/*  libcsupport.h
- *
- *  This include file contains the information regarding the
- *  RTEMS specific support for the standard C library.
- *
- *  COPYRIGHT (c) 1989-1999.
+/*
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h
index f5cb537210..f929669359 100644
--- a/cpukit/libcsupport/include/rtems/libio_.h
+++ b/cpukit/libcsupport/include/rtems/libio_.h
@@ -1,11 +1,11 @@
 /**
  * @file rtems/libio_.h
+ *
+ * This file is the libio internal interface.
  */
 
 /*
- *  Libio Internal Information
- *
- *  COPYRIGHT (c) 1989-1999.
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/rtems/malloc.h b/cpukit/libcsupport/include/rtems/malloc.h
index 67dcf8747b..e1dfb08445 100644
--- a/cpukit/libcsupport/include/rtems/malloc.h
+++ b/cpukit/libcsupport/include/rtems/malloc.h
@@ -1,11 +1,11 @@
 /**
  * @file rtems/malloc.h
+ *
+ * This file defines the interface to RTEMS extensions to the Malloc Family.
  */
 
 /*
- *  RTEMS Malloc Extensions
- *
- *  COPYRIGHT (c) 1989-2009.
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may in
diff --git a/cpukit/libcsupport/include/rtems/termiostypes.h b/cpukit/libcsupport/include/rtems/termiostypes.h
index ebba9ca9f7..08c49c86bc 100644
--- a/cpukit/libcsupport/include/rtems/termiostypes.h
+++ b/cpukit/libcsupport/include/rtems/termiostypes.h
@@ -1,11 +1,11 @@
 /**
  * @file rtems/termiostypes.h
+ *
+ * RTEMS termios device support internal data structures
  */
 
 /*
- *  RTEMS termios device support internal data structures
- *
- *  COPYRIGHT (c) 1989-2008.
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/spurious.h b/cpukit/libcsupport/include/spurious.h
index 9aeffb53ce..bd4b6b3b8d 100644
--- a/cpukit/libcsupport/include/spurious.h
+++ b/cpukit/libcsupport/include/spurious.h
@@ -1,12 +1,11 @@
 /**
  * @file rtems/spurious.h
+ *
+ * This file describes the Spurious Interrupt Driver for all boards.
  */
 
-/*  spurious.h
- *
- *  This file describes the Spurious Interrupt Driver for all boards.
- *
- *  COPYRIGHT (c) 1989, 1990, 1991, 1992, 1993.
+/*
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/sys/statvfs.h b/cpukit/libcsupport/include/sys/statvfs.h
index 1029eb3c6b..8fefdcaba7 100644
--- a/cpukit/libcsupport/include/sys/statvfs.h
+++ b/cpukit/libcsupport/include/sys/statvfs.h
@@ -1,3 +1,12 @@
+/**
+ * @file sys/statvfs.h
+ *
+ * This include file defines the interface to the statvfs() set of
+ * API methods. The statvfs as defined by the SUS:
+ *
+ *  - http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/statvfs.h.html
+ */
+
 /*
  *  COPYRIGHT (c) 2009 Chris Johns <chrisj@rtems.org>
  *
@@ -7,9 +16,8 @@
  *
  *  $Id$
  */
+
 /*
- * The statvfs as defined by the SUS:
- *    http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/statvfs.h.html
  */
 
 #ifndef _SYS_STATVFS_H_
diff --git a/cpukit/libcsupport/include/sys/termios.h b/cpukit/libcsupport/include/sys/termios.h
index f619c95709..219bc2fefa 100644
--- a/cpukit/libcsupport/include/sys/termios.h
+++ b/cpukit/libcsupport/include/sys/termios.h
@@ -1,7 +1,11 @@
-/*
- *  POSIX termios implementation for RTEMS console device driver.
+/**
+ * @file sys/termios.h
  *
- *  COPYRIGHT (c) 1989-1999.
+ * POSIX termios implementation for RTEMS console device driver.
+ */
+
+/*
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/sys/utsname.h b/cpukit/libcsupport/include/sys/utsname.h
index b1b2e6ef41..37d18b75cf 100644
--- a/cpukit/libcsupport/include/sys/utsname.h
+++ b/cpukit/libcsupport/include/sys/utsname.h
@@ -1,4 +1,16 @@
-/*  sys/utsname.h
+/**
+ * @file sys/utsname.h
+ *
+ * This include file defines the interface to the POSIX utsname() service.
+ */
+
+/*
+ *  COPYRIGHT (c) 1989-2011.
+ *  On-Line Applications Research Corporation (OAR).
+ *
+ *  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.
  *
  *  $Id$
  */
diff --git a/cpukit/libcsupport/include/zilog/z8036.h b/cpukit/libcsupport/include/zilog/z8036.h
index 707b6dd567..057c8e45ed 100644
--- a/cpukit/libcsupport/include/zilog/z8036.h
+++ b/cpukit/libcsupport/include/zilog/z8036.h
@@ -1,15 +1,15 @@
 /**
  * @file rtems/zilog/z8036.h
+ *
+ * This include file defines information related to a Zilog Z8036
+ * Counter/Timer/IO Chip.  It is a memory mapped part.
+ *
+ * @note This file shares as much as possible with the include file
+ * for the Z8536 via z8x36.h.
  */
 
 /*
- *  This include file defines information related to a Zilog Z8036
- *  Counter/Timer/IO Chip.  It is a memory mapped part.
- *
- *  NOTE: This file shares as much as possible with the include
- *        file for the Z8536 via z8x36.h.
- *
- *  COPYRIGHT (c) 1989-1999.
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/zilog/z8530.h b/cpukit/libcsupport/include/zilog/z8530.h
index 13c63536c4..1458518d84 100644
--- a/cpukit/libcsupport/include/zilog/z8530.h
+++ b/cpukit/libcsupport/include/zilog/z8530.h
@@ -1,12 +1,12 @@
 /**
  * @file rtems/zilog/z8530.h
+ *
+ *  This include file defines information related to a Zilog Z8530
+ *  SCC Chip.  It is a IO mapped part.
  */
 
 /*
- *  This include file defines information related to a Zilog Z8530
- *  SCC Chip.  It is a IO mapped part.
- *
- *  COPYRIGHT (c) 1989-1999.
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libcsupport/include/zilog/z8536.h b/cpukit/libcsupport/include/zilog/z8536.h
index b67bd4cf9c..6eb18565b0 100644
--- a/cpukit/libcsupport/include/zilog/z8536.h
+++ b/cpukit/libcsupport/include/zilog/z8536.h
@@ -1,19 +1,15 @@
 /**
  * @file rtems/zilog/z8536.h
+ *
+ * This include file defines information related to a Zilog Z8536
+ * Counter/Timer/IO Chip.  It is a IO mapped part.
+ *
+ * @note This file shares as much as possible with the include
+ *       file for the Z8036 via z8x36.h.
  */
 
 /*
- *  This include file defines information related to a Zilog Z8536
- *  Counter/Timer/IO Chip.  It is a IO mapped part.
- *
- *  Input parameters:   NONE
- *
- *  Output parameters:  NONE
- *
- *  NOTE: This file shares as much as possible with the include
- *        file for the Z8036 via z8x36.h.
- *
- *  COPYRIGHT (c) 1989-1999.
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be