diff options
| author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2011-06-24 17:52:58 +0000 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2011-06-24 17:52:58 +0000 |
| commit | 21242c252a47fd32d8ae5b077489f9ff2151bc88 (patch) | |
| tree | 1b0dafb0edba91d8bcfc9901e646e57acffc3b29 /cpukit | |
| parent | 2011-06-24 Joel Sherrill <joel.sherrill@oarcorp.com> (diff) | |
| download | rtems-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')
91 files changed, 537 insertions, 309 deletions
diff --git a/cpukit/ChangeLog b/cpukit/ChangeLog index 2cfa3d978e..184f33100b 100644 --- a/cpukit/ChangeLog +++ b/cpukit/ChangeLog @@ -1,5 +1,74 @@ 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. + +2011-06-24 Joel Sherrill <joel.sherrill@oarcorp.com> + * Doxyfile.in, score/include/rtems/score/apimutex.h, score/include/rtems/score/basedefs.h, score/include/rtems/score/coremsg.h, 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 diff --git a/cpukit/libblock/include/rtems/flashdisk.h b/cpukit/libblock/include/rtems/flashdisk.h index c24b9b08be..31b65007de 100644 --- a/cpukit/libblock/include/rtems/flashdisk.h +++ b/cpukit/libblock/include/rtems/flashdisk.h @@ -1,6 +1,10 @@ -/* - * flashdisk.h -- Flash disk block device implementation +/** + * @file rtems/flashdisk.h * + * This file defines the interface to a flash disk block device. + */ + +/* * Copyright (C) 2007 Chris Johns * * The license and distribution terms for this file may be diff --git a/cpukit/libblock/include/rtems/nvdisk-sram.h b/cpukit/libblock/include/rtems/nvdisk-sram.h index 450cfd8602..21dc0e19d3 100644 --- a/cpukit/libblock/include/rtems/nvdisk-sram.h +++ b/cpukit/libblock/include/rtems/nvdisk-sram.h @@ -1,3 +1,9 @@ +/** + * @file rtems/nvdisk-sram.h + * + * This driver maps an NV disk to static RAM. You can use this + */ + /* * $Id$ * @@ -6,12 +12,6 @@ * Copyright 2007 Chris Johns (chrisj@rtems.org) */ -/** - * NV Disk Static RAM Device Driver. - * - * This driver maps an NV disk to static RAM. You can use this - */ - #if !defined (_RTEMS_NVDISK_SRAM_H_) #define _RTEMS_NVDISK_SRAM_H_ diff --git a/cpukit/libblock/include/rtems/nvdisk.h b/cpukit/libblock/include/rtems/nvdisk.h index 48d8ba0b16..ffdd3ada6a 100644 --- a/cpukit/libblock/include/rtems/nvdisk.h +++ b/cpukit/libblock/include/rtems/nvdisk.h @@ -1,6 +1,10 @@ -/* - * nvdisk.h -- Non-volatile disk block device implementation +/** + * @file rtems/nvdisk.h * + * Non-volatile disk block device implementation + */ + +/* * Copyright (C) 2007 Chris Johns * * The license and distribution terms for this file may be 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 diff --git a/cpukit/libfs/src/imfs/imfs.h b/cpukit/libfs/src/imfs/imfs.h index aec8febdc5..fa6f1313e5 100644 --- a/cpukit/libfs/src/imfs/imfs.h +++ b/cpukit/libfs/src/imfs/imfs.h @@ -1,7 +1,11 @@ -/* - * Header file for the In-Memory File System +/** + * @file rtems/imfs.h * - * COPYRIGHT (c) 1989-2010. + * Header file for the In-Memory File System + */ + +/* + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/libfs/src/pipe/pipe.h b/cpukit/libfs/src/pipe/pipe.h index 354cc9d130..52d0a85143 100644 --- a/cpukit/libfs/src/pipe/pipe.h +++ b/cpukit/libfs/src/pipe/pipe.h @@ -1,6 +1,11 @@ -/* - * pipe.h: header of POSIX FIFO/pipe +/** + * @file rtems/pipe.h * + * This include file defines the interface to the POSIX FIFO/pipe file system + * support. + */ + +/* * Author: Wei Shen <cquark@gmail.com> * * The license and distribution terms for this file may be 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> * diff --git a/cpukit/libnetworking/memory.h b/cpukit/libnetworking/memory.h index 7ef4cda388..99fdb5e1e4 100644 --- a/cpukit/libnetworking/memory.h +++ b/cpukit/libnetworking/memory.h @@ -1,4 +1,6 @@ -/* +/** + * @file memory.h + * * Dummy include file for FreeBSD routines */ diff --git a/cpukit/posix/include/aio.h b/cpukit/posix/include/aio.h index becb4abb86..2039187b57 100644 --- a/cpukit/posix/include/aio.h +++ b/cpukit/posix/include/aio.h @@ -1,9 +1,12 @@ /** * @file aio.h + * + * This file contains the definitions related to POSIX Asynchronous + * Input and Output, */ /* - * COPYRIGHT (c) 1989-2007. + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/include/mqueue.h b/cpukit/posix/include/mqueue.h index f08dc0754b..459011d7f1 100644 --- a/cpukit/posix/include/mqueue.h +++ b/cpukit/posix/include/mqueue.h @@ -1,9 +1,11 @@ /** * @file mqueue.h + * + * This file contains the definitions related to POSIX Message Queues. */ /* - * 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/posix/include/rtems/posix/aio_misc.h b/cpukit/posix/include/rtems/posix/aio_misc.h index c90d509d44..9e44000326 100644 --- a/cpukit/posix/include/rtems/posix/aio_misc.h +++ b/cpukit/posix/include/rtems/posix/aio_misc.h @@ -1,3 +1,9 @@ +/** + * @file rtems/posix/aio_misc.h + * + * This defines private information for the AIO implementation. + */ + /* * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> * @@ -8,7 +14,6 @@ * $Id$ */ - #ifndef _AIO_MISC_H #define _AIO_MISC_H diff --git a/cpukit/posix/include/rtems/posix/barrier.h b/cpukit/posix/include/rtems/posix/barrier.h index 6bb2aa2e5c..79970b1b2b 100644 --- a/cpukit/posix/include/rtems/posix/barrier.h +++ b/cpukit/posix/include/rtems/posix/barrier.h @@ -1,18 +1,18 @@ /** * @file rtems/posix/barrier.h - */ - -/* + * * This include file contains all the constants and structures associated * with the POSIX Barrier Manager. * * Directives provided are: * - * + create a barrier - * + delete a barrier - * + wait for a barrier - * - * COPYRIGHT (c) 1989-2008. + * - create a barrier + * - delete a barrier + * - wait for a barrier + */ + +/* + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/include/rtems/posix/cond.h b/cpukit/posix/include/rtems/posix/cond.h index 5ed8dfeed7..bf77eebd30 100644 --- a/cpukit/posix/include/rtems/posix/cond.h +++ b/cpukit/posix/include/rtems/posix/cond.h @@ -1,12 +1,12 @@ /** * @file rtems/posix/cond.h + * + * This include file contains all the private support information for + * POSIX condition variables. */ /* - * This include file contains all the private support information for - * POSIX condition variables. - * - * 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/posix/include/rtems/posix/config.h b/cpukit/posix/include/rtems/posix/config.h index b6ad91fb34..053fa0290e 100644 --- a/cpukit/posix/include/rtems/posix/config.h +++ b/cpukit/posix/include/rtems/posix/config.h @@ -1,8 +1,8 @@ /** * @file rtems/posix/config.h * - * This include file contains the table of user defined configuration - * parameters specific for the POSIX API. + * This include file contains the table of user defined configuration + * parameters specific for the POSIX API. */ /* diff --git a/cpukit/posix/include/rtems/posix/key.h b/cpukit/posix/include/rtems/posix/key.h index e39aa98d53..e49efda9d7 100644 --- a/cpukit/posix/include/rtems/posix/key.h +++ b/cpukit/posix/include/rtems/posix/key.h @@ -1,13 +1,12 @@ /** * @file rtems/posix/key.h + * + * This include file contains all the private support information for + * POSIX key. */ -/* rtems/posix/key.h - * - * This include file contains all the private support information for - * POSIX key. - * - * COPYRIGHT (c) 1989-2010. +/* + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/include/rtems/posix/mqueue.h b/cpukit/posix/include/rtems/posix/mqueue.h index 1e2e7a7429..9e5f07b435 100644 --- a/cpukit/posix/include/rtems/posix/mqueue.h +++ b/cpukit/posix/include/rtems/posix/mqueue.h @@ -1,12 +1,12 @@ /** * @file rtems/posix/mqueue.h * - * This include file contains all the private support information for - * POSIX Message Queues. + * This include file contains all the private support information for + * POSIX Message Queues. */ /* - * 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/posix/include/rtems/posix/mutex.h b/cpukit/posix/include/rtems/posix/mutex.h index 4309edfaa8..2b6fa38629 100644 --- a/cpukit/posix/include/rtems/posix/mutex.h +++ b/cpukit/posix/include/rtems/posix/mutex.h @@ -1,12 +1,11 @@ /** * @file rtems/posix/mutex.h - */ + * + * This include file contains all the private support information for + * POSIX mutex's. /* - * This include file contains all the private support information for - * POSIX mutex's. - * - * 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/posix/include/rtems/posix/posixapi.h b/cpukit/posix/include/rtems/posix/posixapi.h index 729a6db163..f90d4a76d2 100644 --- a/cpukit/posix/include/rtems/posix/posixapi.h +++ b/cpukit/posix/include/rtems/posix/posixapi.h @@ -1,9 +1,12 @@ /** * @file rtems/posix/posixapi.h + * + * This include file defines the top level interface to the POSIX API + * implementation in RTEMS. */ /* - * 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/posix/include/rtems/posix/priority.h b/cpukit/posix/include/rtems/posix/priority.h index 5944c4e7c3..8baca4293a 100644 --- a/cpukit/posix/include/rtems/posix/priority.h +++ b/cpukit/posix/include/rtems/posix/priority.h @@ -1,9 +1,12 @@ /** * @file rtems/posix/priority.h + * + * This include file defines the interface to the POSIX priority + * implementation. */ /* - * 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/posix/include/rtems/posix/psignal.h b/cpukit/posix/include/rtems/posix/psignal.h index 87b629ef52..28d4a7dad0 100644 --- a/cpukit/posix/include/rtems/posix/psignal.h +++ b/cpukit/posix/include/rtems/posix/psignal.h @@ -1,9 +1,11 @@ /** * @file rtems/posix/psignal.h + * + * This include file defines internal information about POSIX signals. */ /* - * 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/posix/include/rtems/posix/pthread.h b/cpukit/posix/include/rtems/posix/pthread.h index 6185afa62c..5dbd7c5f67 100644 --- a/cpukit/posix/include/rtems/posix/pthread.h +++ b/cpukit/posix/include/rtems/posix/pthread.h @@ -1,12 +1,12 @@ /** * @file rtems/posix/pthread.h + * + * This include file contains all the private support information for + * POSIX threads. */ /* - * This include file contains all the private support information for - * POSIX threads. - * - * 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/posix/include/rtems/posix/ptimer.h b/cpukit/posix/include/rtems/posix/ptimer.h index 79fba9d819..046a7af477 100644 --- a/cpukit/posix/include/rtems/posix/ptimer.h +++ b/cpukit/posix/include/rtems/posix/ptimer.h @@ -1,14 +1,14 @@ /** * @file rtems/posix/ptimer.h + * + * This include file contains all the private support information for + * POSIX timers. */ -/* rtems/posix/ptimer.h - * - * This include file contains all the private support information for - * POSIX timers. - * - * COPYRIGHT (c) 1998. - * Alfonso Escalera Piña +/* + * Initial Implementation: + * COPYRIGHT (c) 1998. Alfonso Escalera Piña + * Largely rewritten by Joel Sherrill. * * The license and distribution terms for this file may be * found in the file LICENSE in this distribution or at diff --git a/cpukit/posix/include/rtems/posix/rwlock.h b/cpukit/posix/include/rtems/posix/rwlock.h index 2774e02379..a58823734b 100644 --- a/cpukit/posix/include/rtems/posix/rwlock.h +++ b/cpukit/posix/include/rtems/posix/rwlock.h @@ -1,18 +1,18 @@ /** * @file rtems/posix/rwlock.h - */ - -/* - * This include file contains all the constants and structures associated - * with the POSIX RWLock Manager. * - * Directives provided are: + * This include file contains all the constants and structures associated + * with the POSIX RWLock Manager. * - * + create a RWLock - * + delete a RWLock - * + wait for a RWLock + * Directives provided are: * - * COPYRIGHT (c) 1989-2008. + * - create a RWLock + * - delete a RWLock + * - wait for a RWLock + */ + +/* + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/include/rtems/posix/semaphore.h b/cpukit/posix/include/rtems/posix/semaphore.h index 5f232eea54..3b96748aa7 100644 --- a/cpukit/posix/include/rtems/posix/semaphore.h +++ b/cpukit/posix/include/rtems/posix/semaphore.h @@ -1,13 +1,12 @@ /** * @file rtems/posix/semaphore.h + * + * This include file contains all the private support information for + * POSIX Semaphores. */ -/* rtems/posix/semaphore.h - * - * This include file contains all the private support information for - * POSIX Semaphores. - * - * 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/posix/include/rtems/posix/sigset.h b/cpukit/posix/include/rtems/posix/sigset.h index 338879e5e2..085c2fbddd 100644 --- a/cpukit/posix/include/rtems/posix/sigset.h +++ b/cpukit/posix/include/rtems/posix/sigset.h @@ -1,9 +1,12 @@ /** * @file rtems/posix/sigset.h + * + * This file defines the interface to implementation helper for management + * of POSIX Signal Sets. */ /* - * 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/posix/include/rtems/posix/spinlock.h b/cpukit/posix/include/rtems/posix/spinlock.h index cf6cb6fbd2..770d0411bf 100644 --- a/cpukit/posix/include/rtems/posix/spinlock.h +++ b/cpukit/posix/include/rtems/posix/spinlock.h @@ -1,18 +1,18 @@ /** * @file rtems/posix/spinlock.h - */ - -/* - * This include file contains all the constants and structures associated - * with the POSIX Spinlock Manager. * - * Directives provided are: + * This include file contains all the constants and structures associated + * with the POSIX Spinlock Manager. * - * + create a spinlock - * + delete a spinlock - * + wait for a spinlock + * Directives provided are: * - * COPYRIGHT (c) 1989-2008. + * - create a spinlock + * - delete a spinlock + * - wait for a spinlock + */ + +/* + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/include/rtems/posix/threadsup.h b/cpukit/posix/include/rtems/posix/threadsup.h index cc3a87e99a..c7bd99ad33 100644 --- a/cpukit/posix/include/rtems/posix/threadsup.h +++ b/cpukit/posix/include/rtems/posix/threadsup.h @@ -1,9 +1,11 @@ /** * @file rtems/posix/threadsup.h + * + * This defines the POSIX thread API extension. */ /* - * 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/posix/include/rtems/posix/time.h b/cpukit/posix/include/rtems/posix/time.h index b4b6bd7e67..6562d2864b 100644 --- a/cpukit/posix/include/rtems/posix/time.h +++ b/cpukit/posix/include/rtems/posix/time.h @@ -1,9 +1,12 @@ /** * @file rtems/posix/time.h + * + * This defines the interface to implementation helper routines related + * to POSIX time types. */ /* - * 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/posix/include/rtems/posix/timer.h b/cpukit/posix/include/rtems/posix/timer.h index c061e9d6b7..ce1dc71370 100644 --- a/cpukit/posix/include/rtems/posix/timer.h +++ b/cpukit/posix/include/rtems/posix/timer.h @@ -1,9 +1,12 @@ /** * @file rtems/posix/timer.h + * + * This include files defines the internal support for implementation of + * POSIX Timers. */ /* - * 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/posix/include/semaphore.h b/cpukit/posix/include/semaphore.h index 5727456b34..87ccefd726 100644 --- a/cpukit/posix/include/semaphore.h +++ b/cpukit/posix/include/semaphore.h @@ -1,9 +1,12 @@ /** * @file semaphore.h - */ + * + * This file contains definitions that are internal to the RTEMS + * implementation of POSIX Semaphores. + * /* - * COPYRIGHT (c) 1989-2007. + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/inline/rtems/posix/barrier.inl b/cpukit/posix/inline/rtems/posix/barrier.inl index 2557f33cd8..e077b07227 100644 --- a/cpukit/posix/inline/rtems/posix/barrier.inl +++ b/cpukit/posix/inline/rtems/posix/barrier.inl @@ -1,12 +1,12 @@ /** * @file rtems/posix/barrier.inl + * + * This file contains the static inlin implementation of the inlined + * routines from the POSIX Barrier Manager. */ /* - * This file contains the static inlin implementation of the inlined - * routines from the POSIX Barrier Manager. - * - * COPYRIGHT (c) 1989-2006. + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/inline/rtems/posix/cond.inl b/cpukit/posix/inline/rtems/posix/cond.inl index 3b011c0383..cd6bd0c77e 100644 --- a/cpukit/posix/inline/rtems/posix/cond.inl +++ b/cpukit/posix/inline/rtems/posix/cond.inl @@ -1,13 +1,12 @@ /** * @file rtems/posix/cond.inl + * + * This include file contains the static inline implementation of the private + * inlined routines for POSIX condition variables. */ -/* rtems/posix/cond.inl - * - * This include file contains the static inline implementation of the private - * inlined routines for POSIX condition variables. - * - * COPYRIGHT (c) 1989-2002. +/* + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/inline/rtems/posix/mqueue.inl b/cpukit/posix/inline/rtems/posix/mqueue.inl index 62bc3ce327..5d7399591a 100644 --- a/cpukit/posix/inline/rtems/posix/mqueue.inl +++ b/cpukit/posix/inline/rtems/posix/mqueue.inl @@ -1,13 +1,12 @@ /** * @file rtems/posix/mqueue.inl + * + * This include file contains the static inline implementation of the private + * inlined routines for POSIX Message Queue. */ -/* rtems/posix/mqueue.inl - * - * This include file contains the static inline implementation of the private - * inlined routines for POSIX Message Queue. - * - * 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/posix/inline/rtems/posix/mutex.inl b/cpukit/posix/inline/rtems/posix/mutex.inl index b5e3721a3a..718a342be1 100644 --- a/cpukit/posix/inline/rtems/posix/mutex.inl +++ b/cpukit/posix/inline/rtems/posix/mutex.inl @@ -1,13 +1,11 @@ /** * @file rtems/posix/mutex.inl - */ - -/* rtems/posix/mutex.inl * - * This include file contains the static inline implementation of the private - * inlined routines for POSIX mutex's. - * - * COPYRIGHT (c) 1989-1999. + * This include file contains the static inline implementation of the private + * inlined routines for POSIX mutex's. + *? + +/* COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/inline/rtems/posix/priority.inl b/cpukit/posix/inline/rtems/posix/priority.inl index 9a9f538a61..0865044c27 100644 --- a/cpukit/posix/inline/rtems/posix/priority.inl +++ b/cpukit/posix/inline/rtems/posix/priority.inl @@ -1,9 +1,11 @@ /** * @file rtems/posix/priority.inl + * + * This defines the static inline methods related to POSIX priority management. */ /* - * 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/posix/inline/rtems/posix/pthread.inl b/cpukit/posix/inline/rtems/posix/pthread.inl index 7f35e9a08b..7173e7651d 100644 --- a/cpukit/posix/inline/rtems/posix/pthread.inl +++ b/cpukit/posix/inline/rtems/posix/pthread.inl @@ -1,13 +1,12 @@ /** * @file rtems/posix/pthread.inl + * + * This include file contains the static inline implementation of the private + * inlined routines for POSIX threads. */ -/* rtems/posix/pthread.inl - * - * This include file contains the static inline implementation of the private - * inlined routines for POSIX threads. - * - * 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/posix/inline/rtems/posix/rwlock.inl b/cpukit/posix/inline/rtems/posix/rwlock.inl index ac11d35d3c..ed2d0cb345 100644 --- a/cpukit/posix/inline/rtems/posix/rwlock.inl +++ b/cpukit/posix/inline/rtems/posix/rwlock.inl @@ -1,12 +1,12 @@ /** - * @file rtems/posix/RWLock.inl + * @file rtems/posix/rwlock.inl + * + * This file contains the static inlin implementation of the inlined + * routines from the POSIX RWLock Manager. */ /* - * This file contains the static inlin implementation of the inlined - * routines from the POSIX RWLock Manager. - * - * COPYRIGHT (c) 1989-2006. + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/inline/rtems/posix/semaphore.inl b/cpukit/posix/inline/rtems/posix/semaphore.inl index eb885f1aa0..cd1dcbb235 100644 --- a/cpukit/posix/inline/rtems/posix/semaphore.inl +++ b/cpukit/posix/inline/rtems/posix/semaphore.inl @@ -1,13 +1,12 @@ /** * @file rtems/posix/semaphore.inl + * + * This include file contains the static inline implementation of the private + * inlined routines for POSIX Semaphores. */ -/* rtems/posix/semaphore.inl - * - * This include file contains the static inline implementation of the private - * inlined routines for POSIX Semaphores. - * - * 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/posix/inline/rtems/posix/spinlock.inl b/cpukit/posix/inline/rtems/posix/spinlock.inl index 6007258e01..bed3eca9ed 100644 --- a/cpukit/posix/inline/rtems/posix/spinlock.inl +++ b/cpukit/posix/inline/rtems/posix/spinlock.inl @@ -1,12 +1,12 @@ /** * @file rtems/posix/spinlock.inl + * + * This file contains the static inlin implementation of the inlined + * routines from the POSIX Spinlock Manager. */ /* - * This file contains the static inlin implementation of the inlined - * routines from the POSIX Spinlock Manager. - * - * COPYRIGHT (c) 1989-2006. + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/inline/rtems/posix/timer.inl b/cpukit/posix/inline/rtems/posix/timer.inl index 63db10c8ab..c210e4d25d 100644 --- a/cpukit/posix/inline/rtems/posix/timer.inl +++ b/cpukit/posix/inline/rtems/posix/timer.inl @@ -1,13 +1,12 @@ /** * @file rtems/posix/timer.inl + * + * This file contains the static inline implementation of the inlined routines + * from the POSIX Timer Manager. */ -/* timer.inl - * - * This file contains the static inline implementation of the inlined routines - * from the POSIX Timer Manager. - * - * 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/rtems/include/rtems/rtems/barrier.h b/cpukit/rtems/include/rtems/rtems/barrier.h index 566d0299e5..5bcb32e04e 100644 --- a/cpukit/rtems/include/rtems/rtems/barrier.h +++ b/cpukit/rtems/include/rtems/rtems/barrier.h @@ -6,11 +6,11 @@ * * Directives provided are: * - * - create a barrier - * - get an ID of a barrier - * - delete a barrier - * - wait for a barrier - * - signal a barrier + * - create a barrier + * - get an ID of a barrier + * - delete a barrier + * - wait for a barrier + * - signal a barrier */ /* COPYRIGHT (c) 1989-2008. diff --git a/cpukit/rtems/include/rtems/rtems/object.h b/cpukit/rtems/include/rtems/rtems/object.h index f18b644cd9..ea09bddf41 100644 --- a/cpukit/rtems/include/rtems/rtems/object.h +++ b/cpukit/rtems/include/rtems/rtems/object.h @@ -1,8 +1,10 @@ /** * @file rtems/rtems/object.h + * + * This include file defines Classic API interfaces to Object Services. */ -/* 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/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h index a328e9a0d1..b7c729042c 100644 --- a/cpukit/rtems/include/rtems/rtems/timer.h +++ b/cpukit/rtems/include/rtems/rtems/timer.h @@ -22,7 +22,8 @@ * - cancel a time */ -/* COPYRIGHT (c) 1989-2009. +/* + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * Copyright (c) 2009 embedded brains GmbH. diff --git a/cpukit/rtems/inline/rtems/rtems/barrier.inl b/cpukit/rtems/inline/rtems/rtems/barrier.inl index 3bec0f2075..c2d37428fb 100644 --- a/cpukit/rtems/inline/rtems/rtems/barrier.inl +++ b/cpukit/rtems/inline/rtems/rtems/barrier.inl @@ -1,11 +1,12 @@ /** * @file rtems/rtems/barrier.inl * - * This file contains the static inlin implementation of the inlined - * routines from the Barrier Manager. + * This file contains the static inlin implementation of the inlined + * routines from the Barrier Manager. */ -/* COPYRIGHT (c) 1989-2008. +/* + * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/rtems/inline/rtems/rtems/timer.inl b/cpukit/rtems/inline/rtems/rtems/timer.inl index 10cae3f67d..951d84295a 100644 --- a/cpukit/rtems/inline/rtems/rtems/timer.inl +++ b/cpukit/rtems/inline/rtems/rtems/timer.inl @@ -1,11 +1,12 @@ /** * @file rtems/rtems/timer.inl * - * This file contains the static inline implementation of the inlined routines - * from the Timer Manager. + * This file contains the static inline implementation of the inlined routines + * from the Timer Manager. */ -/* 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/rtems/mainpage.h b/cpukit/rtems/mainpage.h index fe8f627c36..8449defcbb 100644 --- a/cpukit/rtems/mainpage.h +++ b/cpukit/rtems/mainpage.h @@ -1,5 +1,11 @@ +/** + * @file rtems/rtems/mainpage.h + * + * This file exists to provide a top level description of RTEMS for Doxygen. + */ + /* - * 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/rtems/src/semtranslatereturncode.c b/cpukit/rtems/src/semtranslatereturncode.c index 02b665e5f6..7e131b59d9 100644 --- a/cpukit/rtems/src/semtranslatereturncode.c +++ b/cpukit/rtems/src/semtranslatereturncode.c @@ -71,7 +71,7 @@ const rtems_status_code _Semaphore_Translate_core_mutex_return_code_[] = { RTEMS_OBJECT_WAS_DELETED, /* CORE_MUTEX_WAS_DELETED */ RTEMS_TIMEOUT, /* CORE_MUTEX_TIMEOUT */ #if defined(__RTEMS_STRICT_ORDER_MUTEX__) - CORE_MUTEX_RELEASE_NOT_ORDER, + 123, #endif RTEMS_INVALID_PRIORITY /* CORE_MUTEX_STATUS_CEILING_VIOLATED */ }; diff --git a/cpukit/sapi/include/rtems/config.h b/cpukit/sapi/include/rtems/config.h index cdf33874d7..c2d71b0746 100644 --- a/cpukit/sapi/include/rtems/config.h +++ b/cpukit/sapi/include/rtems/config.h @@ -1,11 +1,11 @@ /** * @file rtems/config.h + * + * This include file contains the table of user defined configuration + * parameters. */ /* - * This include file contains the table of user defined configuration - * parameters. - * * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/sapi/include/rtems/fatal.h b/cpukit/sapi/include/rtems/fatal.h index 63942aad97..a9d91743be 100644 --- a/cpukit/sapi/include/rtems/fatal.h +++ b/cpukit/sapi/include/rtems/fatal.h @@ -1,18 +1,17 @@ /** * @file rtems/fatal.h - */ - -/* - * This include file contains constants and prototypes related - * to the Fatal Error Manager. This manager processes all fatal or - * irrecoverable errors. - * - * This manager provides directives to: * - * + announce a fatal error has occurred + * This include file contains constants and prototypes related + * to the Fatal Error Manager. This manager processes all fatal or + * irrecoverable errors. * + * This manager provides directives to: * - * COPYRIGHT (c) 1989-1999. + * - announce a fatal error has occurred + */ + +/* + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/sapi/include/rtems/mptables.h b/cpukit/sapi/include/rtems/mptables.h index bcb51c5e96..1094629a6d 100644 --- a/cpukit/sapi/include/rtems/mptables.h +++ b/cpukit/sapi/include/rtems/mptables.h @@ -1,9 +1,12 @@ -/* mptables.h +/** + * @file rtems/mptables.h * - * This include file contains the executive's pre-initialized tables - * used in a multiprocessor configuration. - * - * COPYRIGHT (c) 1989-1999. + * This include file contains the executive's pre-initialized tables + * used in a multiprocessor 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/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h index d7864830a3..703050feaa 100644 --- a/cpukit/score/include/rtems/score/object.h +++ b/cpukit/score/include/rtems/score/object.h @@ -1,15 +1,13 @@ /** * @file rtems/score/object.h * - * - * This include file contains all the constants and structures associated - * with the Object Handler. This Handler provides mechanisms which - * can be used to initialize and manipulate all objects which have - * ids. + * This include file contains all the constants and structures associated + * with the Object Handler. This Handler provides mechanisms which + * can be used to initialize and manipulate all objects which have ids. */ /* - * 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/score/include/rtems/score/priority.h b/cpukit/score/include/rtems/score/priority.h index db423de481..7fc20c2c25 100644 --- a/cpukit/score/include/rtems/score/priority.h +++ b/cpukit/score/include/rtems/score/priority.h @@ -1,13 +1,13 @@ /** - * @file rtems/score/priority.h + * @file rtems/score/priority.h * - * This include file contains all thread priority manipulation routines. - * This Handler provides mechanisms which can be used to - * initialize and manipulate thread priorities. + * This include file contains all thread priority manipulation routines. + * This Handler provides mechanisms which can be used to + * initialize and manipulate thread priorities. */ /* - * COPYRIGHT (c) 1989-2010. + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/score/inline/rtems/score/object.inl b/cpukit/score/inline/rtems/score/object.inl index d4d39acac6..ac07e68235 100644 --- a/cpukit/score/inline/rtems/score/object.inl +++ b/cpukit/score/inline/rtems/score/object.inl @@ -1,13 +1,12 @@ /** * @file rtems/score/object.inl + * + * This include file contains the static inline implementation of all + * of the inlined routines in the Object Handler. */ /* - * - * This include file contains the static inline implementation of all - * of the inlined routines in the Object Handler. - * - * 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/score/inline/rtems/score/priority.inl b/cpukit/score/inline/rtems/score/priority.inl index 089a81ebda..796a14e2b9 100644 --- a/cpukit/score/inline/rtems/score/priority.inl +++ b/cpukit/score/inline/rtems/score/priority.inl @@ -1,12 +1,12 @@ /** - * @file rtems/score/priority.inl + * @file rtems/score/priority.inl * - * This file contains the static inline implementation of all inlined - * routines in the Priority Handler. + * This file contains the static inline implementation of all inlined + * routines in the Priority Handler. */ /* - * COPYRIGHT (c) 1989-2004. + * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be |