Add doxygen preamble.

2004-11-21 06:27:15 +00:00
parent 3394273c72
commit 6c2675dfb2
45 changed files with 188 additions and 14 deletions
--- a/cpukit/posix/include/aio.h
+++ b/cpukit/posix/include/aio.h
@@ -1,5 +1,8 @@
-/* aio.h
- *
+/**
+ * @file aio.h
+ */
+
+/*
 *  $Id$
 */

--- a/cpukit/posix/include/devctl.h
+++ b/cpukit/posix/include/devctl.h
@@ -1,5 +1,8 @@
-/* devctl.h
- *
+/**
+ * @file devctl.h
+ */
+
+/*
 *  $Id$
 */

--- 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$
 */

--- a/cpukit/posix/include/mqueue.h
+++ b/cpukit/posix/include/mqueue.h
@@ -1,5 +1,8 @@
-/* mqueue.h
- *
+/**
+ * @file mqueue.h
+ */
+
+/*
 *  $Id$
 */

--- 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$
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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).
 *
--- 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
--- 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
--- 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
--- 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
 *
--- 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
+ */
+
 /*
 *
 *
--- 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$
 */
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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$
--- 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
+ */
+
 /*
 *
 *
--- 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$
 */
--- a/cpukit/posix/include/sched.h
+++ b/cpukit/posix/include/sched.h
@@ -1,5 +1,8 @@
-/*  sched.h
- *
+/**
+ * @file sched.h
+ */
+
+/*
 *  $Id$
 */

--- a/cpukit/posix/include/semaphore.h
+++ b/cpukit/posix/include/semaphore.h
@@ -1,5 +1,8 @@
-/*  semaphore.h
- *
+/**
+ * @file semaphore.h
+ */
+
+/*
 *  $Id$
 */

--- 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 
--- 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 
--- 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 
--- 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 
--- 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 
--- 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$
 */
--- 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 
--- 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 
--- 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
--- 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 
--- 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 
--- 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 
--- 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 
--- 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 
--- 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$
 */
--- 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 
--- 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 
--- 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