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, 21 insertions, 19 deletions

diff --git a/cpukit/rtems/include/rtems.h b/cpukit/rtems/include/rtems.h
index 249aa1cc04..e4441ec069 100644
--- a/cpukit/rtems/include/rtems.h
+++ b/cpukit/rtems/include/rtems.h
@@ -1,14 +1,13 @@
 /**
  * @file  rtems.h
- */
- 
-/*
+ *
  *  This include file contains information about RTEMS executive that
  *  is required by the application and is CPU independent.  It includes
  *  two (2) CPU dependent files to tailor its data structures for a
  *  particular processor.
- *
- *  COPYRIGHT (c) 1989-2008.
+ */
+
+/*  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -21,6 +20,13 @@
 #ifndef _RTEMS_H
 #define _RTEMS_H
 
+/**
+ *  @defgroup ClassicRTEMS Classic API RTEMS Header
+ *
+ *  This encapsulates functionality which XXX
+ */
+/**@{*/
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -72,57 +78,53 @@ extern "C" {
 
 #define RTEMS_HAS_HARDWARE_FP CPU_HARDWARE_FP
 
-/*
+/**
  *  The following define the constants which may be used in name searches.
  */
-
 #define RTEMS_SEARCH_ALL_NODES   OBJECTS_SEARCH_ALL_NODES
 #define RTEMS_SEARCH_OTHER_NODES OBJECTS_SEARCH_OTHER_NODES
 #define RTEMS_SEARCH_LOCAL_NODE  OBJECTS_SEARCH_LOCAL_NODE
 #define RTEMS_WHO_AM_I           OBJECTS_WHO_AM_I
 
-/*
+/**
  * Parameters and return id's for _Objects_Get_next
  */
-
 #define RTEMS_OBJECT_ID_INITIAL_INDEX        OBJECTS_ID_INITIAL_INDEX
 #define RTEMS_OBJECT_ID_FINAL_INDEX          OBJECTS_ID_FINAL_INDEX
 #define RTEMS_OBJECT_ID_INITIAL(api, class, node) OBJECTS_ID_INITIAL(api, class, node)
 
 #define RTEMS_OBJECT_ID_FINAL                OBJECTS_ID_FINAL
 
-/*
+/**
  *  The following constant defines the minimum stack size which every
  *  thread must exceed.
  */
-
 #define RTEMS_MINIMUM_STACK_SIZE  STACK_MINIMUM_SIZE
 
-/*
+/**
  *  Constant for indefinite wait.  (actually an illegal interval)
  */
-
 #define RTEMS_NO_TIMEOUT  WATCHDOG_NO_TIMEOUT
 
-/*
+/**
  *  An MPCI must support packets of at least this size.
  */
-
 #define RTEMS_MINIMUM_PACKET_SIZE  MP_PACKET_MINIMUM_PACKET_SIZE
 
-/*
- *  The following constant defines the number of uint32_t  's
+/**
+ *  The following constant defines the number of uint32_t's
  *  in a packet which must be converted to native format in a
  *  heterogeneous system.  In packets longer than
- *  MP_PACKET_MINIMUN_HETERO_CONVERSION uint32_t  's, some of the "extra" data
+ *  MP_PACKET_MINIMUN_HETERO_CONVERSION uint32_t's, some of the "extra" data
  *  may a user message buffer which is not automatically endian swapped.
  */
-
 #define RTEMS_MINIMUN_HETERO_CONVERSION  MP_PACKET_MINIMUN_HETERO_CONVERSION
 
 #ifdef __cplusplus
 }
 #endif
 
+/**@}*/
+
 #endif
 /* end of include file */