[rtems commit] rtems misc: doxygen minor fixes

Gedare Bloom gedare at rtems.org
Thu Dec 6 15:20:22 UTC 2012


Module:    rtems
Branch:    master
Commit:    8b03bbcba4e4795ae5fa91f651ca6318fc7f2f07
Changeset: http://git.rtems.org/rtems/commit/?id=8b03bbcba4e4795ae5fa91f651ca6318fc7f2f07

Author:    Gedare Bloom <gedare at rtems.org>
Date:      Thu Dec  6 10:24:53 2012 -0500

rtems misc: doxygen minor fixes

---

 cpukit/rtems/include/rtems/rtems/dpmem.h |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h
index 16544d8..42601d5 100644
--- a/cpukit/rtems/include/rtems/rtems/dpmem.h
+++ b/cpukit/rtems/include/rtems/rtems/dpmem.h
@@ -85,10 +85,10 @@ RTEMS_DPMEM_EXTERN Objects_Information  _Dual_ported_memory_Information;
 void _Dual_ported_memory_Manager_initialization(void);
 
 /**
- *  @brief RTEMS Create Port
+ *  @brief Creates a port into a dual-ported memory area.
  *
  *  This routine implements the rtems_port_create directive.  The port
- *  will have the name name.  The port maps onto an area of dual ported
+ *  will have the name @a name.  The port maps onto an area of dual ported
  *  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.
@@ -97,7 +97,7 @@ void _Dual_ported_memory_Manager_initialization(void);
  *  @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[in] id is the address of port id to set
+ *  @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




More information about the vc mailing list