summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include/rtems/score/corerwlock.h
diff options
context:
space:
mode:
authorMathew Kallada <matkallada@gmail.com>2012-12-28 18:04:01 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2012-12-28 18:04:01 -0600
commit319cb20efbf1e4759b4bb22ace32fbc60df8bf3d (patch)
tree252cd34de14758a320b4d122a573459ba656a77f /cpukit/score/include/rtems/score/corerwlock.h
parentHeader File Doxygen Enhancement Task #1 (diff)
downloadrtems-319cb20efbf1e4759b4bb22ace32fbc60df8bf3d.tar.bz2
score: Doxygen Clean Up Task #2
Diffstat (limited to '')
-rw-r--r--cpukit/score/include/rtems/score/corerwlock.h19
1 files changed, 11 insertions, 8 deletions
diff --git a/cpukit/score/include/rtems/score/corerwlock.h b/cpukit/score/include/rtems/score/corerwlock.h
index 3b70d80701..2279a75bfe 100644
--- a/cpukit/score/include/rtems/score/corerwlock.h
+++ b/cpukit/score/include/rtems/score/corerwlock.h
@@ -1,6 +1,8 @@
/**
* @file rtems/score/corerwlock.h
*
+ * @brief Constants and Structures Associated with the RWLock Handler
+ *
* This include file contains all the constants and structures associated
* with the RWLock Handler.
*/
@@ -125,7 +127,7 @@ typedef struct {
} CORE_RWLock_Control;
/**
- * @brief Initialize a RWlock
+ * @brief Initialize a RWlock.
*
* This routine initializes the RWLock based on the parameters passed.
*
@@ -138,7 +140,8 @@ void _CORE_RWLock_Initialize(
);
/**
- * @brief Obtain RWLock for reading
+ * @brief Obtain RWLock for reading.
+ *
* This routine attempts to obtain the RWLock for read access.
*
* @param[in] the_rwlock is the RWLock to wait for
@@ -161,8 +164,8 @@ void _CORE_RWLock_Obtain_for_reading(
);
/**
- * @brief RWLock Obtain for Writing
- *
+ * @brief Obtain RWLock for writing.
+ *
* This routine attempts to obtain the RWLock for write exclusive access.
*
* @param[in] the_rwlock is the RWLock to wait for
@@ -184,14 +187,14 @@ void _CORE_RWLock_Obtain_for_writing(
);
/**
- * @brief Releases the RWLock
+ * @brief Release the RWLock.
*
* This routine manually releases @a the_rwlock. All of the threads waiting
* for the RWLock will be readied.
*
* @param[in] the_rwlock is the RWLock to surrender
*
- * @return Status is returned to indicate successful or failure.
+ * @retval Status is returned to indicate successful or failure.
*/
CORE_RWLock_Status _CORE_RWLock_Release(
CORE_RWLock_Control *the_rwlock
@@ -214,7 +217,7 @@ CORE_RWLock_Status _CORE_RWLock_Release(
)
/**
- * @brief RWLock Specific Thread Queue Timeout
+ * @brief RWLock specific thread queue timeout.
*
* This routine processes a thread which timeouts while waiting on
* an RWLock's thread queue. It is called by the watchdog handler.
@@ -240,4 +243,4 @@ void _CORE_RWLock_Timeout(
/**@}*/
#endif
-/* end of include file */
+/* end of include file */ \ No newline at end of file