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.

12 files changed, 76 insertions, 20 deletions

diff --git a/cpukit/libmisc/capture/capture-cli.h b/cpukit/libmisc/capture/capture-cli.h
index 99c4e2252c..a2d126cbae 100644
--- a/cpukit/libmisc/capture/capture-cli.h
+++ b/cpukit/libmisc/capture/capture-cli.h
@@ -1,5 +1,8 @@
 /**
  * @file rtems/capture-cli.h
+ *
+ * This is the Target Interface Command Line Interface. You need
+ * start the RTEMS monitor.
  */
 
 /*
diff --git a/cpukit/libmisc/capture/capture.h b/cpukit/libmisc/capture/capture.h
index 48ba5ebec4..f6cfe15872 100644
--- a/cpukit/libmisc/capture/capture.h
+++ b/cpukit/libmisc/capture/capture.h
@@ -1,5 +1,8 @@
 /**
  * @file rtems/capture.h
+ *
+ * This is the Capture Engine component of the RTEMS Measurement and
+ * Monitoring system.
  */
 
 /*
diff --git a/cpukit/libmisc/cpuuse/cpuuse.h b/cpukit/libmisc/cpuuse/cpuuse.h
index b38927e7c6..fd182aa21f 100644
--- a/cpukit/libmisc/cpuuse/cpuuse.h
+++ b/cpukit/libmisc/cpuuse/cpuuse.h
@@ -1,9 +1,12 @@
-/*  cpuuse.h
+/**
+ * @file rtems/cpuuse.h
  *
- *  This include file contains information necessary to utilize
- *  and install the cpu usage reporting mechanism.
- *
- *  COPYRIGHT (c) 1989-2007.
+ * This include file contains information necessary to utilize
+ * and install the cpu usage reporting mechanism.
+ */
+
+/*
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libmisc/devnull/devnull.h b/cpukit/libmisc/devnull/devnull.h
index 4fe90cde6c..42b0bfde8d 100644
--- a/cpukit/libmisc/devnull/devnull.h
+++ b/cpukit/libmisc/devnull/devnull.h
@@ -1,7 +1,11 @@
-/*  devnull.h
- *
- *  Null device driver, derived from rtems' stub driver.
+/**
+ * @file rtems/devnull.h
  *
+ * This include file defines the interface to the RTEMS /dev/null
+ * device driver.
+ */
+
+/*
  *  Author: Ralf Corsepius (corsepiu@faw.uni-ulm.de)
  *
  *  COPYRIGHT (c) 1989-2000.
diff --git a/cpukit/libmisc/devnull/devzero.h b/cpukit/libmisc/devnull/devzero.h
index 7e5fb62a29..a313d8241b 100644
--- a/cpukit/libmisc/devnull/devzero.h
+++ b/cpukit/libmisc/devnull/devzero.h
@@ -1,3 +1,10 @@
+/**
+ * @file rtems/devzero.h
+ *
+ * This include file defines the interface to the RTEMS /dev/zero
+ * device driver.
+ */
+
 /*
  * Copyright (c) 2011 embedded brains GmbH.  All rights reserved.
  *
diff --git a/cpukit/libmisc/dumpbuf/dumpbuf.h b/cpukit/libmisc/dumpbuf/dumpbuf.h
index 3502ace70a..7c9a2165ad 100644
--- a/cpukit/libmisc/dumpbuf/dumpbuf.h
+++ b/cpukit/libmisc/dumpbuf/dumpbuf.h
@@ -1,5 +1,12 @@
+/**
+ * @file rtems/dumpbuf.h
+ *
+ * This file defines the interface to the RTEMS methods to print a
+ * memory buffer in a style similar to many ROM monitors and debuggers.
+ */
+
 /*
- *  COPYRIGHT (c) 1997-2007.
+ *  COPYRIGHT (c) 1997-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may in
diff --git a/cpukit/libmisc/fb/fb.h b/cpukit/libmisc/fb/fb.h
index cf49d7bd91..90b2b029fe 100644
--- a/cpukit/libmisc/fb/fb.h
+++ b/cpukit/libmisc/fb/fb.h
@@ -1,3 +1,8 @@
+/** @file rtems/fb.h
+ *
+ * This file defines the interface to a frame buffer device driver.
+ */
+
 /*
  * Copyright (c) 2000 - Rosimildo da Silva
  *
diff --git a/cpukit/libmisc/fb/mw_uid.h b/cpukit/libmisc/fb/mw_uid.h
index 89f440acf4..4d667769c3 100644
--- a/cpukit/libmisc/fb/mw_uid.h
+++ b/cpukit/libmisc/fb/mw_uid.h
@@ -1,9 +1,12 @@
-/*
- * Copyright (c) 2000 - Rosimildo da Silva
+/**
+ * @file rtems/mw_uid.h
  *
- * MODULE DESCRIPTION:
- * This module defines the interface for input devices used by MicroWindows
+ * This file defines the interface for input devices used by MicroWindows
  * in an embedded system environment.
+ */
+
+/*
+ * Copyright (c) 2000 - Rosimildo da Silva
  *
  * $Id$
  */
diff --git a/cpukit/libmisc/mouse/mouse_parser.h b/cpukit/libmisc/mouse/mouse_parser.h
index 59b6abb2f3..b675d7010a 100644
--- a/cpukit/libmisc/mouse/mouse_parser.h
+++ b/cpukit/libmisc/mouse/mouse_parser.h
@@ -1,7 +1,12 @@
+/**
+ * @file rtems/mouse_parser.h
+ *
+ * This file is the header file for the Mouse Parser Engine.
+ */
+
 /*
- * This file is the header file for the Mouse Parser Engine which
- * is derived from a UNIX Serial Port Mouse Driver with the following
- * notice:
+ * This file is derived from a UNIX Serial Port Mouse Driver with the
+ * following notice:
  *
  * ==================================================================
  * Copyright (c) 1999 Greg Haerr <greg@censoft.com>
diff --git a/cpukit/libmisc/shell/shellconfig.h b/cpukit/libmisc/shell/shellconfig.h
index cfc475095e..8e0b38ca4c 100644
--- a/cpukit/libmisc/shell/shellconfig.h
+++ b/cpukit/libmisc/shell/shellconfig.h
@@ -1,7 +1,11 @@
-/*
- *  RTEMS Shell Command Set Configuration
+/**
+ * @file rtems/shellconfig.h
  *
- *  COPYRIGHT (c) 1989-2007.
+ * RTEMS Shell Command Set Configuration
+ */
+
+/*
+ *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libmisc/stringto/stringto.h b/cpukit/libmisc/stringto/stringto.h
index dfb1617bc9..ffe75ed0fd 100644
--- a/cpukit/libmisc/stringto/stringto.h
+++ b/cpukit/libmisc/stringto/stringto.h
@@ -1,5 +1,11 @@
+/**
+ * @file rtems/stringto.h
+ *
+ * This file defines the interface to a set of string conversion helpers.
+ */
+
 /*
- *  COPYRIGHT (c) 2009.
+ *  COPYRIGHT (c) 2009-2011.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
diff --git a/cpukit/libmisc/untar/untar.h b/cpukit/libmisc/untar/untar.h
index 264753f2f7..d572b4d73a 100644
--- a/cpukit/libmisc/untar/untar.h
+++ b/cpukit/libmisc/untar/untar.h
@@ -1,3 +1,9 @@
+/**
+ * @file rtems/untar.h
+ *
+ * This file defines the interface to methods which can untar an image.
+ */
+
 /*
  *  Written by: Jake Janovetz <janovetz@tempest.ece.uiuc.edu>
  *