summaryrefslogtreecommitdiffstats
path: root/cpukit/include
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2011-06-24 17:52:58 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2011-06-24 17:52:58 +0000
commit21242c252a47fd32d8ae5b077489f9ff2151bc88 (patch)
tree1b0dafb0edba91d8bcfc9901e646e57acffc3b29 /cpukit/include
parent2011-06-24 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-21242c252a47fd32d8ae5b077489f9ff2151bc88.tar.bz2
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.
Diffstat (limited to 'cpukit/include')
-rw-r--r--cpukit/include/rtems/bspIo.h11
-rw-r--r--cpukit/include/rtems/concat.h6
-rw-r--r--cpukit/include/rtems/endian.h6
-rw-r--r--cpukit/include/rtems/fs.h10
-rw-r--r--cpukit/include/rtems/irq.h11
-rw-r--r--cpukit/include/rtems/pci.h8
-rw-r--r--cpukit/include/rtems/userenv.h10
7 files changed, 46 insertions, 16 deletions
diff --git a/cpukit/include/rtems/bspIo.h b/cpukit/include/rtems/bspIo.h
index 372dbd4970..537100927f 100644
--- a/cpukit/include/rtems/bspIo.h
+++ b/cpukit/include/rtems/bspIo.h
@@ -1,9 +1,12 @@
-/* bspIo.h
- *
- * This include file contains declaration of interface that
- * will be provided by the file contained in this directory.
+/**
+ * @file rtems/bspIo.h
*
+ * This include file defines the interface to kernel print methods.
+ */
+
+/*
* COPYRIGHT (c) 1998 valette@crf.canon.fr
+ * COPYRIGHT (c) 2011 On-Line Applications Research Corporation.
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
diff --git a/cpukit/include/rtems/concat.h b/cpukit/include/rtems/concat.h
index 02d45f21a4..22036b464e 100644
--- a/cpukit/include/rtems/concat.h
+++ b/cpukit/include/rtems/concat.h
@@ -1,3 +1,9 @@
+/**
+ * @file rtems/concat.h
+ *
+ * This include file defines ANSI concatenation macros.
+ */
+
/*
* Copyright (c) 2004,2005 Ralf Corsepius, Ulm, Germany.
*
diff --git a/cpukit/include/rtems/endian.h b/cpukit/include/rtems/endian.h
index 1321d244c2..90a7caeaa1 100644
--- a/cpukit/include/rtems/endian.h
+++ b/cpukit/include/rtems/endian.h
@@ -1,3 +1,9 @@
+/**
+ * @file rtems/endian.h
+ *
+ * This include file provides endian information about the target.
+ */
+
/*
* $Id$
*/
diff --git a/cpukit/include/rtems/fs.h b/cpukit/include/rtems/fs.h
index cd8a8d5457..84b18370b5 100644
--- a/cpukit/include/rtems/fs.h
+++ b/cpukit/include/rtems/fs.h
@@ -1,7 +1,11 @@
-/*
- * Some basic filesystem types
+/**
+ * @file rtems/fs.h
*
- * COPYRIGHT (c) 1989-1999.
+ * This file defines basic filesystem types
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
diff --git a/cpukit/include/rtems/irq.h b/cpukit/include/rtems/irq.h
index 0da13067b4..154a28e067 100644
--- a/cpukit/include/rtems/irq.h
+++ b/cpukit/include/rtems/irq.h
@@ -1,8 +1,11 @@
-/*
- *
- * This include file describe the data structure and the functions implemented
- * by rtems to write interrupt handlers.
+/**
+ * @file rtems/irq.h
*
+ * This include file describe the data structure and the functions implemented
+ * by rtems to write interrupt handlers.
+ */
+
+/*
* CopyRight (C) 1998 valette@crf.canon.fr
*
* This code is heavilly inspired by the public specification of STREAM V2
diff --git a/cpukit/include/rtems/pci.h b/cpukit/include/rtems/pci.h
index 0b47d9275c..50ce0af1e6 100644
--- a/cpukit/include/rtems/pci.h
+++ b/cpukit/include/rtems/pci.h
@@ -1,6 +1,10 @@
-/*
+/**
+ * @file rtems/pci.h
*
- * PCI defines and function prototypes
+ * PCI defines and function prototypes
+ */
+
+/*
* Copyright 1994, Drew Eckhardt
* Copyright 1997, 1998 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
*
diff --git a/cpukit/include/rtems/userenv.h b/cpukit/include/rtems/userenv.h
index b16374a6dc..ca27c54b15 100644
--- a/cpukit/include/rtems/userenv.h
+++ b/cpukit/include/rtems/userenv.h
@@ -1,7 +1,11 @@
-/*
- * Libio Internal Information
+/**
+ * @file rtems/userenv.h
*
- * COPYRIGHT (c) 1989-1999.
+ * This file defines the interface for POSIX per-process environment.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be