summaryrefslogtreecommitdiff
path: root/cpukit/libmisc
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/libmisc')
-rw-r--r--cpukit/libmisc/capture/capture-cli.h3
-rw-r--r--cpukit/libmisc/capture/capture.h3
-rw-r--r--cpukit/libmisc/cpuuse/cpuuse.h13
-rw-r--r--cpukit/libmisc/devnull/devnull.h10
-rw-r--r--cpukit/libmisc/devnull/devzero.h7
-rw-r--r--cpukit/libmisc/dumpbuf/dumpbuf.h9
-rw-r--r--cpukit/libmisc/fb/fb.h5
-rw-r--r--cpukit/libmisc/fb/mw_uid.h11
-rw-r--r--cpukit/libmisc/mouse/mouse_parser.h11
-rw-r--r--cpukit/libmisc/shell/shellconfig.h10
-rw-r--r--cpukit/libmisc/stringto/stringto.h8
-rw-r--r--cpukit/libmisc/untar/untar.h6
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>
*