2004-10-02 Ralf Corsepius <ralf_corsepiu@rtems.org>

	* rtems/include/rtems.h,
	rtems/include/rtems/rtems/asr.h,
	rtems/include/rtems/rtems/attr.h,
	rtems/include/rtems/rtems/cache.h,
	rtems/include/rtems/rtems/clock.h,
	rtems/include/rtems/rtems/config.h,
	rtems/include/rtems/rtems/dpmem.h,
	rtems/include/rtems/rtems/event.h,
	rtems/include/rtems/rtems/eventmp.h,
	rtems/include/rtems/rtems/eventset.h,
	rtems/include/rtems/rtems/intr.h,
	rtems/include/rtems/rtems/message.h,
	rtems/include/rtems/rtems/modes.h,
	rtems/include/rtems/rtems/mp.h,
	rtems/include/rtems/rtems/msgmp.h,
	rtems/include/rtems/rtems/options.h,
	rtems/include/rtems/rtems/part.h,
	rtems/include/rtems/rtems/partmp.h,
	rtems/include/rtems/rtems/ratemon.h,
	rtems/include/rtems/rtems/region.h,
	rtems/include/rtems/rtems/regionmp.h,
	rtems/include/rtems/rtems/rtemsapi.h,
	rtems/include/rtems/rtems/sem.h,
	rtems/include/rtems/rtems/semmp.h,
	rtems/include/rtems/rtems/signal.h,
	rtems/include/rtems/rtems/signalmp.h,
	rtems/include/rtems/rtems/status.h,
	rtems/include/rtems/rtems/support.h,
	rtems/include/rtems/rtems/taskmp.h,
	rtems/include/rtems/rtems/tasks.h,
	rtems/include/rtems/rtems/timer.h,
	rtems/include/rtems/rtems/types.h: Add doxygen preamble.

32 files changed, 189 insertions, 64 deletions

diff --git a/cpukit/ChangeLog b/cpukit/ChangeLog
index 07b26706a4..2db3d29faa 100644
--- a/cpukit/ChangeLog
+++ b/cpukit/ChangeLog
@@ -1,3 +1,38 @@
+2004-11-02	Ralf Corsepius <ralf_corsepiu@rtems.org>
+
+	* rtems/include/rtems.h,
+	rtems/include/rtems/rtems/asr.h,
+	rtems/include/rtems/rtems/attr.h,
+	rtems/include/rtems/rtems/cache.h,
+	rtems/include/rtems/rtems/clock.h,
+	rtems/include/rtems/rtems/config.h,
+	rtems/include/rtems/rtems/dpmem.h,
+	rtems/include/rtems/rtems/event.h,
+	rtems/include/rtems/rtems/eventmp.h,
+	rtems/include/rtems/rtems/eventset.h,
+	rtems/include/rtems/rtems/intr.h,
+	rtems/include/rtems/rtems/message.h,
+	rtems/include/rtems/rtems/modes.h,
+	rtems/include/rtems/rtems/mp.h,
+	rtems/include/rtems/rtems/msgmp.h,
+	rtems/include/rtems/rtems/options.h,
+	rtems/include/rtems/rtems/part.h,
+	rtems/include/rtems/rtems/partmp.h,
+	rtems/include/rtems/rtems/ratemon.h,
+	rtems/include/rtems/rtems/region.h,
+	rtems/include/rtems/rtems/regionmp.h,
+	rtems/include/rtems/rtems/rtemsapi.h,
+	rtems/include/rtems/rtems/sem.h,
+	rtems/include/rtems/rtems/semmp.h,
+	rtems/include/rtems/rtems/signal.h,
+	rtems/include/rtems/rtems/signalmp.h,
+	rtems/include/rtems/rtems/status.h,
+	rtems/include/rtems/rtems/support.h,
+	rtems/include/rtems/rtems/taskmp.h,
+	rtems/include/rtems/rtems/tasks.h,
+	rtems/include/rtems/rtems/timer.h,
+	rtems/include/rtems/rtems/types.h: Add doxygen preamble.
+
 2004-11-01	Joel Sherrill <joel@OARcorp.com>
 
 	* libmisc/monitor/mon-manager.c, libmisc/monitor/mon-object.c: Remove
diff --git a/cpukit/rtems/include/rtems/rtems/asr.h b/cpukit/rtems/include/rtems/rtems/asr.h
index 740ff8ac68..91ac8a47a7 100644
--- a/cpukit/rtems/include/rtems/rtems/asr.h
+++ b/cpukit/rtems/include/rtems/rtems/asr.h
@@ -1,5 +1,8 @@
-/*  asr.h
- *
+/**
+ * @file rtems/rtems/asr.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Asynchronous Signal Handler.  This Handler provides the low-level
  *  support required by the Signal Manager.
diff --git a/cpukit/rtems/include/rtems/rtems/attr.h b/cpukit/rtems/include/rtems/rtems/attr.h
index 200a434ce6..f9b9b5ef8a 100644
--- a/cpukit/rtems/include/rtems/rtems/attr.h
+++ b/cpukit/rtems/include/rtems/rtems/attr.h
@@ -1,5 +1,8 @@
-/*  attr.h
- *
+/**
+ * @file rtems/rtems/attr.h
+ */
+
+/*
  *  This include file contains all information about the Object Attributes
  *  Handler.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/cache.h b/cpukit/rtems/include/rtems/rtems/cache.h
index d6ba1de217..86c8c9d810 100644
--- a/cpukit/rtems/include/rtems/rtems/cache.h
+++ b/cpukit/rtems/include/rtems/rtems/cache.h
@@ -1,5 +1,8 @@
-/*  cache.h
- *
+/**
+ * @file rtems/rtems/cache.h
+ */
+
+/*
  *  Cache Manager
  *
  *  COPYRIGHT (c) 1989-1999.
diff --git a/cpukit/rtems/include/rtems/rtems/clock.h b/cpukit/rtems/include/rtems/rtems/clock.h
index 8008ba6f89..33ac23fae7 100644
--- a/cpukit/rtems/include/rtems/rtems/clock.h
+++ b/cpukit/rtems/include/rtems/rtems/clock.h
@@ -1,5 +1,8 @@
-/*  clock.h
- *
+/**
+ * @file rtems/rtems/clock.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Clock Manager.  This manager provides facilities to set, obtain,
  *  and continually update the current date and time.
diff --git a/cpukit/rtems/include/rtems/rtems/config.h b/cpukit/rtems/include/rtems/rtems/config.h
index ac965c8aca..2b68e72862 100644
--- a/cpukit/rtems/include/rtems/rtems/config.h
+++ b/cpukit/rtems/include/rtems/rtems/config.h
@@ -1,5 +1,8 @@
-/*  config.h
- *
+/**
+ * @file rtems/rtems/config.h
+ */
+
+/*
  *  This include file contains the table of user defined configuration
  *  parameters specific for the RTEMS API.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h
index 53bb4bfd3e..ed0b44b739 100644
--- a/cpukit/rtems/include/rtems/rtems/dpmem.h
+++ b/cpukit/rtems/include/rtems/rtems/dpmem.h
@@ -1,5 +1,8 @@
-/*  dpmem.h
- *
+/**
+ * @file rtems/rtems/dpmem.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Dual Ported Memory Manager. This manager provides a mechanism
  *  for converting addresses between internal and external representations
diff --git a/cpukit/rtems/include/rtems/rtems/event.h b/cpukit/rtems/include/rtems/rtems/event.h
index 869d20d374..7c22a5b874 100644
--- a/cpukit/rtems/include/rtems/rtems/event.h
+++ b/cpukit/rtems/include/rtems/rtems/event.h
@@ -1,5 +1,8 @@
-/*  event.h
- *
+/**
+ * @file rtems/rtems/event.h
+ */
+
+/*
  *  This include file contains the information pertaining to the Event
  *  Manager.  This manager provides a high performance method of communication
  *  and synchronization.
diff --git a/cpukit/rtems/include/rtems/rtems/eventmp.h b/cpukit/rtems/include/rtems/rtems/eventmp.h
index cf73464092..04ea3b0de8 100644
--- a/cpukit/rtems/include/rtems/rtems/eventmp.h
+++ b/cpukit/rtems/include/rtems/rtems/eventmp.h
@@ -1,5 +1,8 @@
-/*  eventmp.h
- *
+/**
+ * @file rtems/rtems/eventmp.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Multiprocessing Support in the Event Manager.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/eventset.h b/cpukit/rtems/include/rtems/rtems/eventset.h
index e70f5d858b..f0a8e086bb 100644
--- a/cpukit/rtems/include/rtems/rtems/eventset.h
+++ b/cpukit/rtems/include/rtems/rtems/eventset.h
@@ -1,5 +1,8 @@
-/*  eventset.h
- *
+/**
+ * @file rtems/rtems/eventset.h
+ */
+
+/*
  *  This include file contains the information pertaining to the
  *  Event Sets Handler.  This handler provides methods for the manipulation
  *  of event sets which will be sent and received by tasks.
diff --git a/cpukit/rtems/include/rtems/rtems/intr.h b/cpukit/rtems/include/rtems/rtems/intr.h
index 10ed1d0657..c9a0655d9d 100644
--- a/cpukit/rtems/include/rtems/rtems/intr.h
+++ b/cpukit/rtems/include/rtems/rtems/intr.h
@@ -1,5 +1,8 @@
-/*  intr.h
- *
+/**
+ * @file rtems/rtems/intr.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Interrupt Manager.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h
index 97da3f118e..17708cca4c 100644
--- a/cpukit/rtems/include/rtems/rtems/message.h
+++ b/cpukit/rtems/include/rtems/rtems/message.h
@@ -1,5 +1,8 @@
-/*  message.h
- *
+/**
+ * @file rtems/rtems/message.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Message Queue Manager.  This manager provides a mechanism for
  *  communication and synchronization between tasks using messages.
@@ -37,7 +40,6 @@ extern "C" {
 #include <rtems/score/chain.h>
 #include <rtems/score/object.h>
 #include <rtems/rtems/attr.h>
-#include <rtems/score/threadq.h>
 #include <rtems/score/coremsg.h>
 
 /*
diff --git a/cpukit/rtems/include/rtems/rtems/modes.h b/cpukit/rtems/include/rtems/rtems/modes.h
index 55b02e89fb..5f6d4000ef 100644
--- a/cpukit/rtems/include/rtems/rtems/modes.h
+++ b/cpukit/rtems/include/rtems/rtems/modes.h
@@ -1,5 +1,8 @@
-/*  modes.h
- *
+/**
+ * @file rtems/rtems/modes.h
+ */
+
+/*
  *  This include file contains all constants and structures associated
  *  with the RTEMS thread and RTEMS_ASR modes.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/mp.h b/cpukit/rtems/include/rtems/rtems/mp.h
index 1688b09988..b31b4fb493 100644
--- a/cpukit/rtems/include/rtems/rtems/mp.h
+++ b/cpukit/rtems/include/rtems/rtems/mp.h
@@ -1,5 +1,8 @@
-/*  mp.h
- *
+/**
+ * @file rtems/rtems/mp.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Multiprocessing Manager.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/msgmp.h b/cpukit/rtems/include/rtems/rtems/msgmp.h
index c954fb90d6..f489b1dd9a 100644
--- a/cpukit/rtems/include/rtems/rtems/msgmp.h
+++ b/cpukit/rtems/include/rtems/rtems/msgmp.h
@@ -1,5 +1,8 @@
-/*  msgmp.h
- *
+/**
+ * @file rtems/rtems/msgmp.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Multiprocessing Support in the Message Manager.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/options.h b/cpukit/rtems/include/rtems/rtems/options.h
index aaad18ddd5..bd96e0ac51 100644
--- a/cpukit/rtems/include/rtems/rtems/options.h
+++ b/cpukit/rtems/include/rtems/rtems/options.h
@@ -1,5 +1,8 @@
-/*  options.h
- *
+/**
+ * @file rtems/rtems/options.h
+ */
+
+/*
  *  This include file contains information which defines the
  *  options available on many directives.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h
index 9f1a112bc8..e663392b7e 100644
--- a/cpukit/rtems/include/rtems/rtems/part.h
+++ b/cpukit/rtems/include/rtems/rtems/part.h
@@ -1,5 +1,8 @@
-/*  partition.h
- *
+/**
+ * @file rtems/rtems/part.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Partition Manager.  This manager provides facilities to
  *  dynamically allocate memory in fixed-sized units which are returned
diff --git a/cpukit/rtems/include/rtems/rtems/partmp.h b/cpukit/rtems/include/rtems/rtems/partmp.h
index 9d43924291..e9397785d8 100644
--- a/cpukit/rtems/include/rtems/rtems/partmp.h
+++ b/cpukit/rtems/include/rtems/rtems/partmp.h
@@ -1,5 +1,8 @@
-/*  partmp.h
- *
+/**
+ * @file rtems/rtems/partmp.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Multiprocessing Support in the Partition Manager.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h
index d80f10caf5..a8057f96fd 100644
--- a/cpukit/rtems/include/rtems/rtems/ratemon.h
+++ b/cpukit/rtems/include/rtems/rtems/ratemon.h
@@ -1,5 +1,8 @@
-/*  ratemon.h
- *
+/**
+ * @file rtems/rtems/ratemon.h
+ */
+
+/*
  *  This include file contains all the constants, structures, and
  *  prototypes associated with the Rate Monotonic Manager.  This manager
  *  provides facilities to implement tasks which execute in a periodic fashion.
diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h
index c3e5febd32..259a0eb75c 100644
--- a/cpukit/rtems/include/rtems/rtems/region.h
+++ b/cpukit/rtems/include/rtems/rtems/region.h
@@ -1,5 +1,8 @@
-/*  region.h
- *
+/**
+ * @file rtems/rtems/region.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Region Manager.  This manager provides facilities to dynamically
  *  allocate memory in variable sized units which are returned as segments.
diff --git a/cpukit/rtems/include/rtems/rtems/regionmp.h b/cpukit/rtems/include/rtems/rtems/regionmp.h
index 105621bdc7..1d6f4cd0f0 100644
--- a/cpukit/rtems/include/rtems/rtems/regionmp.h
+++ b/cpukit/rtems/include/rtems/rtems/regionmp.h
@@ -1,5 +1,8 @@
-/*  regionmp.h
- *
+/**
+ * @file rtems/rtems/regionmp.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Multiprocessing Support in the Region Manager.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/rtemsapi.h b/cpukit/rtems/include/rtems/rtems/rtemsapi.h
index bc7adaf232..dd725e1a4e 100644
--- a/cpukit/rtems/include/rtems/rtems/rtemsapi.h
+++ b/cpukit/rtems/include/rtems/rtems/rtemsapi.h
@@ -1,8 +1,10 @@
+/**
+ * @file rtems/rtems/rtemsapi.h
+ */
+
 /*
  *  RTEMS API Support
  *
- *  NOTE:
- *
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h
index 8ed92843de..a311bfa2ce 100644
--- a/cpukit/rtems/include/rtems/rtems/sem.h
+++ b/cpukit/rtems/include/rtems/rtems/sem.h
@@ -1,5 +1,8 @@
-/*  semaphore.h
- *
+/**
+ * @file rtems/rtems/sem.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Semaphore Manager.  This manager utilizes standard Dijkstra
  *  counting semaphores to provide synchronization and mutual exclusion
@@ -37,7 +40,6 @@ extern "C" {
 #include <rtems/score/coremutex.h>
 #include <rtems/score/object.h>
 #include <rtems/score/coresem.h>
-#include <rtems/score/threadq.h>
 
 /*
  *  The following defines the control block used to manage each semaphore.
diff --git a/cpukit/rtems/include/rtems/rtems/semmp.h b/cpukit/rtems/include/rtems/rtems/semmp.h
index bf987f4dd9..b78c847c62 100644
--- a/cpukit/rtems/include/rtems/rtems/semmp.h
+++ b/cpukit/rtems/include/rtems/rtems/semmp.h
@@ -1,5 +1,8 @@
-/*  semmp.h
- *
+/**
+ * @file rtems/rtems/semmp.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Multiprocessing Support in the Semaphore Manager.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/signal.h b/cpukit/rtems/include/rtems/rtems/signal.h
index 985e0a24fd..0d70bbb8ba 100644
--- a/cpukit/rtems/include/rtems/rtems/signal.h
+++ b/cpukit/rtems/include/rtems/rtems/signal.h
@@ -1,5 +1,8 @@
-/*  signal.h
- *
+/**
+ * @file rtems/rtems/signal.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Signal Manager.   This manager provides capabilities required
  *  for asynchronous communication between tasks via signal sets.
diff --git a/cpukit/rtems/include/rtems/rtems/signalmp.h b/cpukit/rtems/include/rtems/rtems/signalmp.h
index 3f34667288..0dd1c3d526 100644
--- a/cpukit/rtems/include/rtems/rtems/signalmp.h
+++ b/cpukit/rtems/include/rtems/rtems/signalmp.h
@@ -1,5 +1,8 @@
-/*  signalmp.h
- *
+/**
+ * @file rtems/rtems/signalmp.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the Multiprocessing Support in the Signal Manager.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/status.h b/cpukit/rtems/include/rtems/rtems/status.h
index 3510a8ca36..d4a108e4b3 100644
--- a/cpukit/rtems/include/rtems/rtems/status.h
+++ b/cpukit/rtems/include/rtems/rtems/status.h
@@ -1,5 +1,8 @@
-/*  status.h
- *
+/**
+ * @file rtems/rtems/status.h
+ */
+
+/*
  *  This include file contains the status codes returned from the
  *  executive directives.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/support.h b/cpukit/rtems/include/rtems/rtems/support.h
index 591bbd736c..695178cdfe 100644
--- a/cpukit/rtems/include/rtems/rtems/support.h
+++ b/cpukit/rtems/include/rtems/rtems/support.h
@@ -1,5 +1,8 @@
-/*  support.h
- *
+/**
+ * @file rtems/rtems/support.h
+ */
+
+/*
  *  This include file contains information about support functions for
  *  the RTEMS API.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/taskmp.h b/cpukit/rtems/include/rtems/rtems/taskmp.h
index d78a4e6a61..f955dabbab 100644
--- a/cpukit/rtems/include/rtems/rtems/taskmp.h
+++ b/cpukit/rtems/include/rtems/rtems/taskmp.h
@@ -1,5 +1,8 @@
-/*  taskmp.h
- *
+/**
+ * @file rtems/rtems/taskmp.h
+ */
+
+/*
  *  This include file contains all the constants and structures associated
  *  with the multiprocessing support in the task manager.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h
index 94047ebca7..0edf306d92 100644
--- a/cpukit/rtems/include/rtems/rtems/tasks.h
+++ b/cpukit/rtems/include/rtems/rtems/tasks.h
@@ -1,5 +1,8 @@
-/*  tasks.h
- *
+/**
+ * @file rtems/rtems/tasks.h
+ */
+
+/*
  *  This include file contains all constants and structures associated
  *  with RTEMS tasks.  This manager provides a comprehensive set of directives
  *  to create, delete, and administer tasks.
diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h
index 6e6fe7e4e1..520e6db22c 100644
--- a/cpukit/rtems/include/rtems/rtems/timer.h
+++ b/cpukit/rtems/include/rtems/rtems/timer.h
@@ -1,5 +1,8 @@
-/*  timer.h
- *
+/**
+ * @file rtems/rtems/timer.h
+ */
+
+/*
  *  This include file contains all the constants, structures, and
  *  prototypes associated with the Timer Manager.  This manager provides
  *  facilities to configure, initiate, cancel, and delete timers which will
diff --git a/cpukit/rtems/include/rtems/rtems/types.h b/cpukit/rtems/include/rtems/rtems/types.h
index e77e87cbb6..f800b79592 100644
--- a/cpukit/rtems/include/rtems/rtems/types.h
+++ b/cpukit/rtems/include/rtems/rtems/types.h
@@ -1,5 +1,8 @@
-/*  types.h
- *
+/**
+ * @file rtems/rtems/types.h
+ */
+
+/*
  *  This include file defines the types used by the RTEMS API.
  *
  *  COPYRIGHT (c) 1989-1999.