summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/inline/rtems/rtems/dpmem.inl
diff options
context:
space:
mode:
authorMathew Kallada <matkallada@gmail.com>2012-12-28 17:23:21 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2012-12-28 17:23:21 -0600
commit7ee5bc4ce1d2b596356a5c99ca1e2240ea1f8b62 (patch)
treef5e373ae2b8c710a41bcd2050d1bdd1777cc9c6b /cpukit/rtems/inline/rtems/rtems/dpmem.inl
parentHeader File Doxygen Enhancement Task #11 (diff)
downloadrtems-7ee5bc4ce1d2b596356a5c99ca1e2240ea1f8b62.tar.bz2
rtems: Doxygen Clean Up Task #3
Diffstat (limited to 'cpukit/rtems/inline/rtems/rtems/dpmem.inl')
-rw-r--r--cpukit/rtems/inline/rtems/rtems/dpmem.inl10
1 files changed, 6 insertions, 4 deletions
diff --git a/cpukit/rtems/inline/rtems/rtems/dpmem.inl b/cpukit/rtems/inline/rtems/rtems/dpmem.inl
index c445603a9d..19a4addbca 100644
--- a/cpukit/rtems/inline/rtems/rtems/dpmem.inl
+++ b/cpukit/rtems/inline/rtems/rtems/dpmem.inl
@@ -26,7 +26,8 @@
*/
/**
- * @brief Dual_ported_memory_Allocate
+ * @brief Allocates a port control block from the inactive chain
+ * of free port control blocks.
*
* This routine allocates a port control block from the inactive chain
* of free port control blocks.
@@ -39,7 +40,8 @@ RTEMS_INLINE_ROUTINE Dual_ported_memory_Control
}
/**
- * @brief Dual_ported_memory_Free
+ * @brief Frees a port control block to the inactive chain
+ * of free port control blocks.
*
* This routine frees a port control block to the inactive chain
* of free port control blocks.
@@ -52,7 +54,7 @@ RTEMS_INLINE_ROUTINE void _Dual_ported_memory_Free (
}
/**
- * @brief Dual_ported_memory_Get
+ * @brief Maps port IDs to port control blocks.
*
* This function maps port IDs to port control blocks. If ID
* corresponds to a local port, then it returns the_port control
@@ -71,7 +73,7 @@ RTEMS_INLINE_ROUTINE Dual_ported_memory_Control *_Dual_ported_memory_Get (
}
/**
- * @brief Dual_ported_memory_Is_null
+ * @brief Checks if the_port is NULL.
*
* This function returns true if the_port is NULL and false otherwise.
*/