summaryrefslogtreecommitdiff
path: root/cpukit/score/include/rtems/score/apimutex.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/score/include/rtems/score/apimutex.h')
-rw-r--r--cpukit/score/include/rtems/score/apimutex.h20
1 files changed, 14 insertions, 6 deletions
diff --git a/cpukit/score/include/rtems/score/apimutex.h b/cpukit/score/include/rtems/score/apimutex.h
index 780b16708c..13b0dddd65 100644
--- a/cpukit/score/include/rtems/score/apimutex.h
+++ b/cpukit/score/include/rtems/score/apimutex.h
@@ -57,10 +57,12 @@ typedef struct {
SCORE_EXTERN Objects_Information _API_Mutex_Information;
/**
- * @brief Performs the initialization necessary for this handler.
+ * @brief Initialization for the API Mutexe Handler.
*
- * The value @a maximum_mutexes is the maximum number of API mutexes that may
- * exist at any time.
+ * The value @a maximum_mutexes is the maximum number of API mutexes that may
+ * exist at any time.
+ *
+ * @param[in] Maximum_mutexex is the maximum number of API mutexes.
*/
void _API_Mutex_Initialization( uint32_t maximum_mutexes );
@@ -71,12 +73,18 @@ void _API_Mutex_Initialization( uint32_t maximum_mutexes );
void _API_Mutex_Allocate( API_Mutex_Control **mutex );
/**
- * @brief Acquires the specified API mutex @a mutex.
+ * @brief Acquires the specified API mutex.
*/
-void _API_Mutex_Lock( API_Mutex_Control *mutex );
+void _API_Mutex_Lock(
+ API_Mutex_Control *mutex
+ );
/**
- * @brief Releases the specified API mutex @a mutex.
+ * @brief Releases the Specified API Mutex
+ *
+ * Releases the specified @a mutex.
+ *
+ * @param[in] mutex is the mutex to be removed.
*/
void _API_Mutex_Unlock( API_Mutex_Control *mutex );