2008-04-18 Joel Sherrill <joel.sherrill@oarcorp.com>

	* rtems/include/rtems.h, rtems/include/rtems/rtems/asr.h,
	rtems/include/rtems/rtems/attr.h,
	rtems/include/rtems/rtems/barrier.h,
	rtems/include/rtems/rtems/barriermp.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/object.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, rtems/inline/rtems/rtems/asr.inl,
	rtems/inline/rtems/rtems/attr.inl,
	rtems/inline/rtems/rtems/barrier.inl,
	rtems/inline/rtems/rtems/dpmem.inl,
	rtems/inline/rtems/rtems/event.inl,
	rtems/inline/rtems/rtems/eventset.inl,
	rtems/inline/rtems/rtems/message.inl,
	rtems/inline/rtems/rtems/modes.inl,
	rtems/inline/rtems/rtems/options.inl,
	rtems/inline/rtems/rtems/part.inl,
	rtems/inline/rtems/rtems/ratemon.inl,
	rtems/inline/rtems/rtems/region.inl,
	rtems/inline/rtems/rtems/sem.inl,
	rtems/inline/rtems/rtems/status.inl,
	rtems/inline/rtems/rtems/support.inl,
	rtems/inline/rtems/rtems/tasks.inl,
	rtems/inline/rtems/rtems/timer.inl: Initial conversion of Classic API
	header files to Doxygen.
	* rtems/Doxyfile: New file.

1 files changed, 30 insertions, 44 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/event.h b/cpukit/rtems/include/rtems/rtems/event.h
index 68687af31e..584c76eb8c 100644
--- a/cpukit/rtems/include/rtems/rtems/event.h
+++ b/cpukit/rtems/include/rtems/rtems/event.h
@@ -1,19 +1,18 @@
 /**
  * @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.
  *
  *  Directives provided are:
  *
- *     + send an event set to a task
- *     + receive event condition
+ *     - send an event set to a task
+ *     - receive event condition
  *
- *
- *  COPYRIGHT (c) 1989-2008.
+ */
+
+/*  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -43,43 +42,41 @@ extern "C" {
 #include <rtems/score/watchdog.h>
 #include <rtems/rtems/eventset.h>
 
-/*
+/**
+ *  @defgroup ClassicEvent Classic API Event
+ *
+ *  This encapsulates functionality which XXX
+ */
+/**@{*/
+
+/**
  *  This constant is passed as the event_in to the
  *  rtems_event_receive directive to determine which events are pending.
  */
-
 #define EVENT_CURRENT  0
 
-/*
- *  Event_Manager_initialization
- *
- *  DESCRIPTION:
+/**
+ *  @brief Event_Manager_initialization
  *
  *  This routine performs the initialization necessary for this manager.
  */
-
 void _Event_Manager_initialization( void );
 
-/*
- *  rtems_event_send
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_event_send
  *
  *  This routine implements the rtems_event_send directive.  It sends
  *  event_in to the task specified by ID.  If the task is blocked
  *  waiting to receive events and the posting of event_in satisfies
  *  the task's event condition, then it is unblocked.
  */
-
 rtems_status_code rtems_event_send (
   Objects_Id         id,
   rtems_event_set event_in
 );
 
-/*
- *  rtems_event_receive
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_event_receive
  *
  *  This routine implements the rtems_event_receive directive.  This
  *  directive is invoked when the calling task wishes to receive
@@ -92,7 +89,6 @@ rtems_status_code rtems_event_send (
  *  parameter.  This directive returns the events received in the
  *  event_out parameter.
  */
-
 rtems_status_code rtems_event_receive (
   rtems_event_set  event_in,
   rtems_option     option_set,
@@ -100,10 +96,8 @@ rtems_status_code rtems_event_receive (
   rtems_event_set *event_out
 );
 
-/*
- *  _Event_Seize
- *
- *  DESCRIPTION:
+/**
+ *  @brief Event_Seize
  *
  *  This routine determines if the event condition event_in is
  *  satisfied.  If so or if the no_wait option is enabled in option_set,
@@ -111,7 +105,6 @@ rtems_status_code rtems_event_receive (
  *  conditions is true, then the calling task is blocked with an
  *  optional timeout of ticks clock ticks.
  */
-
 void _Event_Seize (
   rtems_event_set  event_in,
   rtems_option     option_set,
@@ -119,23 +112,18 @@ void _Event_Seize (
   rtems_event_set *event_out
 );
 
-/*
- *  _Event_Surrender
- *
- *  DESCRIPTION:
+/**
+ *  @brief Event_Surrender
  *
  *  This routine determines if the event condition of the_thread
  *  has been satisfied.  If so, it unblocks the_thread.
  */
-
 void _Event_Surrender (
   Thread_Control *the_thread
 );
 
-/*
- *  _Event_Timeout
- *
- *  DESCRIPTION:
+/**
+ *  @brief Event_Timeout
  *
  *  This routine is invoked when a task's event receive request
  *  has not been satisfied after the specified timeout interval.
@@ -143,18 +131,14 @@ void _Event_Surrender (
  *  code will be set in it's control block to indicate that a timeout
  *  has occurred.
  */
-
 void _Event_Timeout (
   Objects_Id  id,
   void       *ignored
 );
 
-/*
- *  The following defines the synchronization flag used by the
- *  Event Manager to insure that signals sent to the currently
- *  executing thread are received properly.
+/**
+ *  @brief he following defines the synchronization flag used by the
  */
-
 RTEMS_EVENT_EXTERN volatile Thread_blocking_operation_States _Event_Sync_state;
 
 #if defined(RTEMS_MULTIPROCESSING)
@@ -168,5 +152,7 @@ RTEMS_EVENT_EXTERN volatile Thread_blocking_operation_States _Event_Sync_state;
 }
 #endif
 
+/**@}*/
+
 #endif
 /* end of include file */