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, 32 insertions, 44 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h
index 37fbc2f445..d14cef2c98 100644
--- a/cpukit/rtems/include/rtems/rtems/dpmem.h
+++ b/cpukit/rtems/include/rtems/rtems/dpmem.h
@@ -1,8 +1,6 @@
 /**
  * @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
@@ -10,14 +8,15 @@
  *
  *  Directives provided are:
  *
- *     + create a port
- *     + get ID of a port
- *     + delete a port
- *     + convert external to internal address
- *     + convert internal to external address
+ *     - create a port
+ *     - get ID of a port
+ *     - delete a port
+ *     - convert external to internal address
+ *     - convert internal to external address
  *
- *
- *  COPYRIGHT (c) 1989-2007.
+ */
+
+/*  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -42,12 +41,18 @@ extern "C" {
 #include <rtems/rtems/support.h>
 #include <rtems/rtems/status.h>
 
-/*
+/**
+ *  @defgroup ClassicDPMEM Classic API Dual Ported Memory
+ *
+ *  This encapsulates functionality which XXX
+ */
+/**@{*/
+
+/**
  *  The following structure defines the port control block.  Each port
  *  has a control block associated with it.  This control block contains
  *  all information required to support the port related operations.
  */
-
 typedef struct {
   Objects_Control  Object;
   void            *internal_base; /* base internal address */
@@ -55,28 +60,22 @@ typedef struct {
   uint32_t         length;        /* length of dual-ported area */
 }   Dual_ported_memory_Control;
 
-/*
+/**
  *  The following define the internal Dual Ported Memory information.
  */
-
 RTEMS_DPMEM_EXTERN Objects_Information  _Dual_ported_memory_Information;
 
-/*
- *  _Dual_ported_memory_Manager_initialization
- *
- *  DESCRIPTION:
+/**
+ *  @brief _Dual_ported_memory_Manager_initialization
  *
  *  This routine performs the initialization necessary for this manager.
  */
-
 void _Dual_ported_memory_Manager_initialization(
   uint32_t   maximum_ports
 );
 
-/*
- *  rtems_port_create
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_port_create
  *
  *  This routine implements the rtems_port_create directive.  The port
  *  will have the name name.  The port maps onto an area of dual ported
@@ -84,7 +83,6 @@ void _Dual_ported_memory_Manager_initialization(
  *  as the internal and external starting addresses, respectively.
  *  It returns the id of the created port in ID.
  */
-
 rtems_status_code rtems_port_create(
   rtems_name    name,
   void         *internal_start,
@@ -93,60 +91,48 @@ rtems_status_code rtems_port_create(
   Objects_Id   *id
 );
 
-/*
- *  rtems_port_ident
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_port_ident
  *
  *  This routine implements the rtems_port_ident directive.  This directive
  *  returns the port ID associated with name.  If more than one port is
  *  named name, then the port to which the ID belongs is arbitrary.
  */
-
 rtems_status_code rtems_port_ident(
   rtems_name    name,
   Objects_Id   *id
 );
 
-/*
- *  rtems_port_delete
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_port_delete
  *
  *  This routine implements the rtems_port_delete directive.  It deletes
  *  the port associated with ID.
  */
-
 rtems_status_code rtems_port_delete(
   Objects_Id id
 );
 
-/*
- *  rtems_port_external_to_internal
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_port_external_to_internal
  *
  *  This routine implements the rtems_port_external_to_internal directive.
  *  It returns the internal port address which maps to the provided
  *  external port address for the specified port ID.
  */
-
 rtems_status_code rtems_port_external_to_internal(
   Objects_Id   id,
   void        *external,
   void       **internal
 );
 
-/*
- *  rtems_port_internal_to_external
- *
- *  DESCRIPTION:
+/**
+ *  @brief rtems_port_internal_to_external
  *
  *  This routine implements the Port_internal_to_external directive.
  *  It returns the external port address which maps to the provided
  *  internal port address for the specified port ID.
  */
-
 rtems_status_code rtems_port_internal_to_external(
   Objects_Id   id,
   void        *internal,
@@ -161,5 +147,7 @@ rtems_status_code rtems_port_internal_to_external(
 }
 #endif
 
+/**@}*/
+
 #endif
 /* end of include file */