From 6c2675dfb2f6d287b277b27089a1ecb6c855600d Mon Sep 17 00:00:00 2001 From: Ralf Corsepius Date: Sun, 21 Nov 2004 06:27:15 +0000 Subject: Add doxygen preamble. --- cpukit/posix/include/aio.h | 7 +++++-- cpukit/posix/include/devctl.h | 7 +++++-- cpukit/posix/include/intr.h | 8 ++++++-- cpukit/posix/include/mqueue.h | 7 +++++-- cpukit/posix/include/rtems/posix/cancel.h | 4 ++++ cpukit/posix/include/rtems/posix/cond.h | 4 ++++ cpukit/posix/include/rtems/posix/condmp.h | 4 ++++ cpukit/posix/include/rtems/posix/config.h | 4 ++++ cpukit/posix/include/rtems/posix/intr.h | 4 ++++ cpukit/posix/include/rtems/posix/key.h | 4 ++++ cpukit/posix/include/rtems/posix/mqueue.h | 7 +++++-- cpukit/posix/include/rtems/posix/mqueuemp.h | 4 ++++ cpukit/posix/include/rtems/posix/mutex.h | 4 ++++ cpukit/posix/include/rtems/posix/mutexmp.h | 4 ++++ cpukit/posix/include/rtems/posix/posixapi.h | 4 ++++ cpukit/posix/include/rtems/posix/priority.h | 4 ++++ cpukit/posix/include/rtems/posix/psignal.h | 4 ++++ cpukit/posix/include/rtems/posix/pthread.h | 4 ++++ cpukit/posix/include/rtems/posix/pthreadmp.h | 4 ++++ cpukit/posix/include/rtems/posix/ptimer.h | 4 ++++ cpukit/posix/include/rtems/posix/semaphore.h | 4 ++++ cpukit/posix/include/rtems/posix/semaphoremp.h | 4 ++++ cpukit/posix/include/rtems/posix/threadsup.h | 4 ++++ cpukit/posix/include/rtems/posix/time.h | 4 ++++ cpukit/posix/include/rtems/posix/timer.h | 4 ++++ cpukit/posix/include/sched.h | 7 +++++-- cpukit/posix/include/semaphore.h | 7 +++++-- cpukit/posix/inline/rtems/posix/cond.inl | 4 ++++ cpukit/posix/inline/rtems/posix/intr.inl | 4 ++++ cpukit/posix/inline/rtems/posix/key.inl | 4 ++++ cpukit/posix/inline/rtems/posix/mqueue.inl | 4 ++++ cpukit/posix/inline/rtems/posix/mutex.inl | 4 ++++ cpukit/posix/inline/rtems/posix/priority.inl | 4 ++++ cpukit/posix/inline/rtems/posix/pthread.inl | 4 ++++ cpukit/posix/inline/rtems/posix/semaphore.inl | 4 ++++ cpukit/posix/inline/rtems/posix/timer.inl | 4 ++++ cpukit/posix/macros/rtems/posix/cond.inl | 4 ++++ cpukit/posix/macros/rtems/posix/intr.inl | 4 ++++ cpukit/posix/macros/rtems/posix/key.inl | 4 ++++ cpukit/posix/macros/rtems/posix/mqueue.inl | 4 ++++ cpukit/posix/macros/rtems/posix/mutex.inl | 4 ++++ cpukit/posix/macros/rtems/posix/priority.inl | 4 ++++ cpukit/posix/macros/rtems/posix/pthread.inl | 4 ++++ cpukit/posix/macros/rtems/posix/semaphore.inl | 4 ++++ cpukit/posix/macros/rtems/posix/timer.inl | 4 ++++ 45 files changed, 188 insertions(+), 14 deletions(-) (limited to 'cpukit/posix') diff --git a/cpukit/posix/include/aio.h b/cpukit/posix/include/aio.h index cc9b17a5b4..49055344fb 100644 --- a/cpukit/posix/include/aio.h +++ b/cpukit/posix/include/aio.h @@ -1,5 +1,8 @@ -/* aio.h - * +/** + * @file aio.h + */ + +/* * $Id$ */ diff --git a/cpukit/posix/include/devctl.h b/cpukit/posix/include/devctl.h index 85fca4cc11..af4fe21c1e 100644 --- a/cpukit/posix/include/devctl.h +++ b/cpukit/posix/include/devctl.h @@ -1,5 +1,8 @@ -/* devctl.h - * +/** + * @file devctl.h + */ + +/* * $Id$ */ diff --git a/cpukit/posix/include/intr.h b/cpukit/posix/include/intr.h index 1464f68b1e..5f8b398099 100644 --- a/cpukit/posix/include/intr.h +++ b/cpukit/posix/include/intr.h @@ -1,8 +1,12 @@ -/* intr.h +/** + * @file intr.h + * * * XXX: It is unclear if the type "intr_t" should be defined when * _POSIX_INTERRUPT_CONTROL is not. - * + */ + +/* * $Id$ */ diff --git a/cpukit/posix/include/mqueue.h b/cpukit/posix/include/mqueue.h index 0b1b834f82..a0d2c29f4a 100644 --- a/cpukit/posix/include/mqueue.h +++ b/cpukit/posix/include/mqueue.h @@ -1,5 +1,8 @@ -/* mqueue.h - * +/** + * @file mqueue.h + */ + +/* * $Id$ */ diff --git a/cpukit/posix/include/rtems/posix/cancel.h b/cpukit/posix/include/rtems/posix/cancel.h index 935912a298..b8cc57037c 100644 --- a/cpukit/posix/include/rtems/posix/cancel.h +++ b/cpukit/posix/include/rtems/posix/cancel.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/cancel.h + */ + /* rtems/posix/cancel.h * * $Id$ diff --git a/cpukit/posix/include/rtems/posix/cond.h b/cpukit/posix/include/rtems/posix/cond.h index c283b84b08..f51ddfd4ba 100644 --- a/cpukit/posix/include/rtems/posix/cond.h +++ b/cpukit/posix/include/rtems/posix/cond.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/cond.h + */ + /* rtems/posix/cond.h * * This include file contains all the private support information for diff --git a/cpukit/posix/include/rtems/posix/condmp.h b/cpukit/posix/include/rtems/posix/condmp.h index f6a9424f9b..37c97d9d42 100644 --- a/cpukit/posix/include/rtems/posix/condmp.h +++ b/cpukit/posix/include/rtems/posix/condmp.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/condmp.h + */ + /* condmp.h * * This include file contains all the constants and structures associated diff --git a/cpukit/posix/include/rtems/posix/config.h b/cpukit/posix/include/rtems/posix/config.h index 8456ed760a..363dc9f7f8 100644 --- a/cpukit/posix/include/rtems/posix/config.h +++ b/cpukit/posix/include/rtems/posix/config.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/config.h + */ + /* config.h * * This include file contains the table of user defined configuration diff --git a/cpukit/posix/include/rtems/posix/intr.h b/cpukit/posix/include/rtems/posix/intr.h index f6f63a4797..3156147231 100644 --- a/cpukit/posix/include/rtems/posix/intr.h +++ b/cpukit/posix/include/rtems/posix/intr.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/intr.h + */ + /* rtems/posix/intr.h * * This include file contains all the private support information for diff --git a/cpukit/posix/include/rtems/posix/key.h b/cpukit/posix/include/rtems/posix/key.h index be9c9579f1..df1a97474f 100644 --- a/cpukit/posix/include/rtems/posix/key.h +++ b/cpukit/posix/include/rtems/posix/key.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/key.h + */ + /* rtems/posix/key.h * * This include file contains all the private support information for diff --git a/cpukit/posix/include/rtems/posix/mqueue.h b/cpukit/posix/include/rtems/posix/mqueue.h index 547091f313..dd3ffeb0d4 100644 --- a/cpukit/posix/include/rtems/posix/mqueue.h +++ b/cpukit/posix/include/rtems/posix/mqueue.h @@ -1,8 +1,11 @@ -/* rtems/posix/mqueue.h +/** + * @file rtems/posix/mqueue.h * * This include file contains all the private support information for * POSIX Message Queues. - * + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/include/rtems/posix/mqueuemp.h b/cpukit/posix/include/rtems/posix/mqueuemp.h index 01206f056b..920dcd9480 100644 --- a/cpukit/posix/include/rtems/posix/mqueuemp.h +++ b/cpukit/posix/include/rtems/posix/mqueuemp.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/mqueuemp.h + */ + /* mqueuemp.h * * This include file contains all the constants and structures associated diff --git a/cpukit/posix/include/rtems/posix/mutex.h b/cpukit/posix/include/rtems/posix/mutex.h index 99911ac3c0..a9570426c0 100644 --- a/cpukit/posix/include/rtems/posix/mutex.h +++ b/cpukit/posix/include/rtems/posix/mutex.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/mutex.h + */ + /* rtems/posix/mutex.h * * This include file contains all the private support information for diff --git a/cpukit/posix/include/rtems/posix/mutexmp.h b/cpukit/posix/include/rtems/posix/mutexmp.h index e3bf586082..97b731af9a 100644 --- a/cpukit/posix/include/rtems/posix/mutexmp.h +++ b/cpukit/posix/include/rtems/posix/mutexmp.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/mutexmp.h + */ + /* mutexmp.h * * This include file contains all the constants and structures associated diff --git a/cpukit/posix/include/rtems/posix/posixapi.h b/cpukit/posix/include/rtems/posix/posixapi.h index 81fd227538..ed0e36a03b 100644 --- a/cpukit/posix/include/rtems/posix/posixapi.h +++ b/cpukit/posix/include/rtems/posix/posixapi.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/posixapi.h + */ + /* * POSIX API Support * diff --git a/cpukit/posix/include/rtems/posix/priority.h b/cpukit/posix/include/rtems/posix/priority.h index bb4b9cfb19..a83c0592d5 100644 --- a/cpukit/posix/include/rtems/posix/priority.h +++ b/cpukit/posix/include/rtems/posix/priority.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/priority.h + */ + /* * * diff --git a/cpukit/posix/include/rtems/posix/psignal.h b/cpukit/posix/include/rtems/posix/psignal.h index 905b243e50..dfacb7db0e 100644 --- a/cpukit/posix/include/rtems/posix/psignal.h +++ b/cpukit/posix/include/rtems/posix/psignal.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/psignal.h + */ + /* * $Id$ */ diff --git a/cpukit/posix/include/rtems/posix/pthread.h b/cpukit/posix/include/rtems/posix/pthread.h index 9a5ff96923..6df2c44b4e 100644 --- a/cpukit/posix/include/rtems/posix/pthread.h +++ b/cpukit/posix/include/rtems/posix/pthread.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/pthread.h + */ + /* rtems/posix/pthread.h * * This include file contains all the private support information for diff --git a/cpukit/posix/include/rtems/posix/pthreadmp.h b/cpukit/posix/include/rtems/posix/pthreadmp.h index 65459c3517..fea2525f5f 100644 --- a/cpukit/posix/include/rtems/posix/pthreadmp.h +++ b/cpukit/posix/include/rtems/posix/pthreadmp.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/pthreadmp.h + */ + /* pthreadmp.h * * This include file contains all the constants and structures associated diff --git a/cpukit/posix/include/rtems/posix/ptimer.h b/cpukit/posix/include/rtems/posix/ptimer.h index a0836d6ea3..dea411849a 100644 --- a/cpukit/posix/include/rtems/posix/ptimer.h +++ b/cpukit/posix/include/rtems/posix/ptimer.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/ptimer.h + */ + /* rtems/posix/ptimer.h * * This include file contains all the private support information for diff --git a/cpukit/posix/include/rtems/posix/semaphore.h b/cpukit/posix/include/rtems/posix/semaphore.h index 4505efdf9d..dad688e7b1 100644 --- a/cpukit/posix/include/rtems/posix/semaphore.h +++ b/cpukit/posix/include/rtems/posix/semaphore.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/semaphore.h + */ + /* rtems/posix/semaphore.h * * This include file contains all the private support information for diff --git a/cpukit/posix/include/rtems/posix/semaphoremp.h b/cpukit/posix/include/rtems/posix/semaphoremp.h index fc6a2f546b..ec7ef39874 100644 --- a/cpukit/posix/include/rtems/posix/semaphoremp.h +++ b/cpukit/posix/include/rtems/posix/semaphoremp.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/semaphoremp.h + */ + /* semaphoremp.h * * This include file contains all the constants and structures associated diff --git a/cpukit/posix/include/rtems/posix/threadsup.h b/cpukit/posix/include/rtems/posix/threadsup.h index 3cb25b3982..07bdd06508 100644 --- a/cpukit/posix/include/rtems/posix/threadsup.h +++ b/cpukit/posix/include/rtems/posix/threadsup.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/threadsup.h + */ + /* threadsup.h * * $Id$ diff --git a/cpukit/posix/include/rtems/posix/time.h b/cpukit/posix/include/rtems/posix/time.h index 83201ec784..446d40c02e 100644 --- a/cpukit/posix/include/rtems/posix/time.h +++ b/cpukit/posix/include/rtems/posix/time.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/time.h + */ + /* * * diff --git a/cpukit/posix/include/rtems/posix/timer.h b/cpukit/posix/include/rtems/posix/timer.h index 285b6ca216..91816a1a74 100644 --- a/cpukit/posix/include/rtems/posix/timer.h +++ b/cpukit/posix/include/rtems/posix/timer.h @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/timer.h + */ + /* * $Id$ */ diff --git a/cpukit/posix/include/sched.h b/cpukit/posix/include/sched.h index 964430b792..d5446bcab4 100644 --- a/cpukit/posix/include/sched.h +++ b/cpukit/posix/include/sched.h @@ -1,5 +1,8 @@ -/* sched.h - * +/** + * @file sched.h + */ + +/* * $Id$ */ diff --git a/cpukit/posix/include/semaphore.h b/cpukit/posix/include/semaphore.h index 79e85f2d6a..d792489334 100644 --- a/cpukit/posix/include/semaphore.h +++ b/cpukit/posix/include/semaphore.h @@ -1,5 +1,8 @@ -/* semaphore.h - * +/** + * @file semaphore.h + */ + +/* * $Id$ */ diff --git a/cpukit/posix/inline/rtems/posix/cond.inl b/cpukit/posix/inline/rtems/posix/cond.inl index 09eac152e1..22c218b31f 100644 --- a/cpukit/posix/inline/rtems/posix/cond.inl +++ b/cpukit/posix/inline/rtems/posix/cond.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/cond.inl + */ + /* rtems/posix/cond.inl * * This include file contains the static inline implementation of the private diff --git a/cpukit/posix/inline/rtems/posix/intr.inl b/cpukit/posix/inline/rtems/posix/intr.inl index 42e332b912..bddbbebd23 100644 --- a/cpukit/posix/inline/rtems/posix/intr.inl +++ b/cpukit/posix/inline/rtems/posix/intr.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/intr.inl + */ + /* rtems/posix/intr.inl * * This include file contains the static inline implementation of the private diff --git a/cpukit/posix/inline/rtems/posix/key.inl b/cpukit/posix/inline/rtems/posix/key.inl index 36f8db9a66..966b9edf50 100644 --- a/cpukit/posix/inline/rtems/posix/key.inl +++ b/cpukit/posix/inline/rtems/posix/key.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/key.inl + */ + /* rtems/posix/key.inl * * This include file contains the static inline implementation of the private diff --git a/cpukit/posix/inline/rtems/posix/mqueue.inl b/cpukit/posix/inline/rtems/posix/mqueue.inl index 58716fab4d..3d380f2368 100644 --- a/cpukit/posix/inline/rtems/posix/mqueue.inl +++ b/cpukit/posix/inline/rtems/posix/mqueue.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/mqueue.inl + */ + /* rtems/posix/mqueue.inl * * This include file contains the static inline implementation of the private diff --git a/cpukit/posix/inline/rtems/posix/mutex.inl b/cpukit/posix/inline/rtems/posix/mutex.inl index a1768ebbf1..6f2160c9ff 100644 --- a/cpukit/posix/inline/rtems/posix/mutex.inl +++ b/cpukit/posix/inline/rtems/posix/mutex.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/mutex.inl + */ + /* rtems/posix/mutex.inl * * This include file contains the static inline implementation of the private diff --git a/cpukit/posix/inline/rtems/posix/priority.inl b/cpukit/posix/inline/rtems/posix/priority.inl index dc8187d4ef..a4329e2668 100644 --- a/cpukit/posix/inline/rtems/posix/priority.inl +++ b/cpukit/posix/inline/rtems/posix/priority.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/priority.inl + */ + /* * $Id$ */ diff --git a/cpukit/posix/inline/rtems/posix/pthread.inl b/cpukit/posix/inline/rtems/posix/pthread.inl index 18303ff91b..82bc2f1647 100644 --- a/cpukit/posix/inline/rtems/posix/pthread.inl +++ b/cpukit/posix/inline/rtems/posix/pthread.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/pthread.inl + */ + /* rtems/posix/pthread.inl * * This include file contains the static inline implementation of the private diff --git a/cpukit/posix/inline/rtems/posix/semaphore.inl b/cpukit/posix/inline/rtems/posix/semaphore.inl index 69229e9119..62f1a1e7f3 100644 --- a/cpukit/posix/inline/rtems/posix/semaphore.inl +++ b/cpukit/posix/inline/rtems/posix/semaphore.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/semaphore.inl + */ + /* rtems/posix/semaphore.inl * * This include file contains the static inline implementation of the private diff --git a/cpukit/posix/inline/rtems/posix/timer.inl b/cpukit/posix/inline/rtems/posix/timer.inl index f70953f18b..90f82eef43 100644 --- a/cpukit/posix/inline/rtems/posix/timer.inl +++ b/cpukit/posix/inline/rtems/posix/timer.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/timer.inl + */ + /* timer.inl * * This file contains the static inline implementation of the inlined routines diff --git a/cpukit/posix/macros/rtems/posix/cond.inl b/cpukit/posix/macros/rtems/posix/cond.inl index e09acd0437..5cec198e23 100644 --- a/cpukit/posix/macros/rtems/posix/cond.inl +++ b/cpukit/posix/macros/rtems/posix/cond.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/cond.inl + */ + /* rtems/posix/cond.inl * * This include file contains the macro implementation of the private diff --git a/cpukit/posix/macros/rtems/posix/intr.inl b/cpukit/posix/macros/rtems/posix/intr.inl index 95dfa04fa8..f09ebc80be 100644 --- a/cpukit/posix/macros/rtems/posix/intr.inl +++ b/cpukit/posix/macros/rtems/posix/intr.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/intr.inl + */ + /* rtems/posix/intr.inl * * This include file contains the macro implementation of the private diff --git a/cpukit/posix/macros/rtems/posix/key.inl b/cpukit/posix/macros/rtems/posix/key.inl index 13fda1dfc9..1e70e2d170 100644 --- a/cpukit/posix/macros/rtems/posix/key.inl +++ b/cpukit/posix/macros/rtems/posix/key.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/key.inl + */ + /* rtems/posix/key.inl * * This include file contains the macro implementation of the private diff --git a/cpukit/posix/macros/rtems/posix/mqueue.inl b/cpukit/posix/macros/rtems/posix/mqueue.inl index a5db662b0d..716c081968 100644 --- a/cpukit/posix/macros/rtems/posix/mqueue.inl +++ b/cpukit/posix/macros/rtems/posix/mqueue.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/mqueue.inl + */ + /* rtems/posix/mqueue.inl * * This include file contains the macro implementation of the private diff --git a/cpukit/posix/macros/rtems/posix/mutex.inl b/cpukit/posix/macros/rtems/posix/mutex.inl index a893397695..f1b9c98a8f 100644 --- a/cpukit/posix/macros/rtems/posix/mutex.inl +++ b/cpukit/posix/macros/rtems/posix/mutex.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/mutex.inl + */ + /* rtems/posix/mutex.inl * * This include file contains the macro implementation of the private diff --git a/cpukit/posix/macros/rtems/posix/priority.inl b/cpukit/posix/macros/rtems/posix/priority.inl index ea1ce82669..eab2bf169a 100644 --- a/cpukit/posix/macros/rtems/posix/priority.inl +++ b/cpukit/posix/macros/rtems/posix/priority.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/priority.inl + */ + /* * $Id$ */ diff --git a/cpukit/posix/macros/rtems/posix/pthread.inl b/cpukit/posix/macros/rtems/posix/pthread.inl index 178c593f52..7fdc4a3a45 100644 --- a/cpukit/posix/macros/rtems/posix/pthread.inl +++ b/cpukit/posix/macros/rtems/posix/pthread.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/pthread.inl + */ + /* rtems/posix/pthread.inl * * This include file contains the macro implementation of the private diff --git a/cpukit/posix/macros/rtems/posix/semaphore.inl b/cpukit/posix/macros/rtems/posix/semaphore.inl index 4fae864c3c..08ee09f1dd 100644 --- a/cpukit/posix/macros/rtems/posix/semaphore.inl +++ b/cpukit/posix/macros/rtems/posix/semaphore.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/semaphore.inl + */ + /* rtems/posix/semaphore.inl * * This include file contains the macro implementation of the private diff --git a/cpukit/posix/macros/rtems/posix/timer.inl b/cpukit/posix/macros/rtems/posix/timer.inl index 6847cad6b3..39575533e9 100644 --- a/cpukit/posix/macros/rtems/posix/timer.inl +++ b/cpukit/posix/macros/rtems/posix/timer.inl @@ -1,3 +1,7 @@ +/** + * @file rtems/posix/timer.inl + */ + /* timer.inl * * This file contains the macro implementation of the inlined routines -- cgit v1.2.3