summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/inline/rtems/rtems/sem.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/sem.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/sem.inl')
-rw-r--r--cpukit/rtems/inline/rtems/rtems/sem.inl12
1 files changed, 7 insertions, 5 deletions
diff --git a/cpukit/rtems/inline/rtems/rtems/sem.inl b/cpukit/rtems/inline/rtems/rtems/sem.inl
index 7b6d0d928f..22699e67ba 100644
--- a/cpukit/rtems/inline/rtems/rtems/sem.inl
+++ b/cpukit/rtems/inline/rtems/rtems/sem.inl
@@ -26,7 +26,8 @@
*/
/**
- * @brief Semaphore_Allocate
+ * @brief Allocates a semaphore control block from
+ * the inactive chain of free semaphore control blocks.
*
* This function allocates a semaphore control block from
* the inactive chain of free semaphore control blocks.
@@ -37,7 +38,8 @@ RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Allocate( void )
}
/**
- * @brief Semaphore_Free
+ * @brief Frees a semaphore control block to the
+ * inactive chain of free semaphore control blocks.
*
* This routine frees a semaphore control block to the
* inactive chain of free semaphore control blocks.
@@ -50,7 +52,7 @@ RTEMS_INLINE_ROUTINE void _Semaphore_Free (
}
/**
- * @brief Semaphore_Get
+ * @brief Maps semaphore IDs to semaphore control blocks.
*
* This function maps semaphore IDs to semaphore control blocks.
* If ID corresponds to a local semaphore, then it returns
@@ -70,7 +72,7 @@ RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Get (
}
/**
- * @brief Semaphore_Get (Interrupts disabled)
+ * @brief Maps semaphore IDs to semaphore control blocks.
*
* This function maps semaphore IDs to semaphore control blocks.
* If ID corresponds to a local semaphore, then it returns
@@ -91,7 +93,7 @@ RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Get_interrupt_disable (
}
/**
- * @brief Semaphore_Is_null
+ * @brief Checks if the_semaphore is NULL.
*
* This function returns TRUE if the_semaphore is NULL and FALSE otherwise.
*/