From 21242c252a47fd32d8ae5b077489f9ff2151bc88 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Fri, 24 Jun 2011 17:52:58 +0000 Subject: 2011-06-24 Joel Sherrill * 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. --- cpukit/posix/include/aio.h | 5 ++++- cpukit/posix/include/mqueue.h | 4 +++- cpukit/posix/include/rtems/posix/aio_misc.h | 7 ++++++- cpukit/posix/include/rtems/posix/barrier.h | 16 ++++++++-------- cpukit/posix/include/rtems/posix/cond.h | 8 ++++---- cpukit/posix/include/rtems/posix/config.h | 4 ++-- cpukit/posix/include/rtems/posix/key.h | 11 +++++------ cpukit/posix/include/rtems/posix/mqueue.h | 6 +++--- cpukit/posix/include/rtems/posix/mutex.h | 9 ++++----- cpukit/posix/include/rtems/posix/posixapi.h | 5 ++++- cpukit/posix/include/rtems/posix/priority.h | 5 ++++- cpukit/posix/include/rtems/posix/psignal.h | 4 +++- cpukit/posix/include/rtems/posix/pthread.h | 8 ++++---- cpukit/posix/include/rtems/posix/ptimer.h | 14 +++++++------- cpukit/posix/include/rtems/posix/rwlock.h | 20 ++++++++++---------- cpukit/posix/include/rtems/posix/semaphore.h | 11 +++++------ cpukit/posix/include/rtems/posix/sigset.h | 5 ++++- cpukit/posix/include/rtems/posix/spinlock.h | 20 ++++++++++---------- cpukit/posix/include/rtems/posix/threadsup.h | 4 +++- cpukit/posix/include/rtems/posix/time.h | 5 ++++- cpukit/posix/include/rtems/posix/timer.h | 5 ++++- cpukit/posix/include/semaphore.h | 7 +++++-- 22 files changed, 106 insertions(+), 77 deletions(-) (limited to 'cpukit/posix/include') 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 * @@ -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 -- cgit v1.2.3