Header File Doxygen Enhancement Task #7

1 files changed, 15 insertions, 12 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h
index 42601d5779..1ea1e02faf 100644
--- a/cpukit/rtems/include/rtems/rtems/dpmem.h
+++ b/cpukit/rtems/include/rtems/rtems/dpmem.h
@@ -1,6 +1,9 @@
 /**
  * @file rtems/rtems/dpmem.h
  *
+ * @brief Constants and Structures Associated with the Dual Ported Memory
+ * Manager
+ *
  *  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
@@ -92,13 +95,13 @@ void _Dual_ported_memory_Manager_initialization(void);
  *  memory of length bytes which has internal_start and external_start
  *  as the internal and external starting addresses, respectively.
  *  It returns the id of the created port in ID.
- * 
+ *
  *  @param[in] name is the user defined port name
  *  @param[in] internal_start is the internal start address of port
  *  @param[in] external_start is the external start address of port
  *  @param[in] length is the physical length in bytes
  *  @param[out] id is the address of port id to set
- * 
+ *
  *  @return This method returns RTEMS_SUCCESSFUL if there was not an
  *          error.  Otherwise, a status code is returned indicating the
  *          source of the error.  If successful, the id will
@@ -118,10 +121,10 @@ rtems_status_code rtems_port_create(
  *  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.
- * 
+ *
  *  @param[in] name is the user defined port name
  *  @param[out] id is the pointer to port id
- * 
+ *
  *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
  */
 rtems_status_code rtems_port_ident(
@@ -134,9 +137,9 @@ rtems_status_code rtems_port_ident(
  *
  *  This routine implements the rtems_port_delete directive.  It deletes
  *  the port associated with ID.
- * 
+ *
  *  @param[in] id is the dual-ported memory area id
- * 
+ *
  *  @return This method returns RTEMS_SUCCESSFUL if there was not an
  *          error.  Otherwise, a status code is returned indicating the
  *          source of the error.
@@ -151,13 +154,13 @@ rtems_status_code rtems_port_delete(
  *  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.If the given external
- *  address is an invalid dual-ported address, then the internal address is 
+ *  address is an invalid dual-ported address, then the internal address is
  *  set to the given external address.
- * 
+ *
  *  @param[in] id is the id of dp memory object
  *  @param[in] external is the external address
  *  @param[out] internal is the pointer of internal address to set
- * 
+ *
  *  @return RTEMS_SUCCESSFUL
  */
 rtems_status_code rtems_port_external_to_internal(
@@ -174,12 +177,12 @@ rtems_status_code rtems_port_external_to_internal(
  *  internal port address for the specified port ID.  If the given
  *  internal address is an invalid dual-ported address, then the
  *  external address is set to the given internal address.
- * 
+ *
  *  @param[in] id is the id of dual-ported memory object
  *  @param[in] internal is the internal address to set
  *  @param[in] external is the pointer to external address
- * 
- *  @return RTEMS_SUCCESSFUL and the external will be filled in 
+ *
+ *  @return RTEMS_SUCCESSFUL and the external will be filled in
  *  with the external addresses
  */
 rtems_status_code rtems_port_internal_to_external(