[rtems commit] doxygen: score: adjust doc in apimutex.h to doxygen guidelines
Sebastian Huber
sebh at rtems.org
Mon May 13 05:52:27 UTC 2019
Module: rtems
Branch: master
Commit: 76a9857cabf22ec2a93f2dff1d836126fda2e0d4
Changeset: http://git.rtems.org/rtems/commit/?id=76a9857cabf22ec2a93f2dff1d836126fda2e0d4
Author: Andreas Dachsberger <andreas.dachsberger at embedded-brains.de>
Date: Thu Apr 4 09:43:03 2019 +0200
doxygen: score: adjust doc in apimutex.h to doxygen guidelines
Update #3706.
---
cpukit/include/rtems/score/apimutex.h | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/cpukit/include/rtems/score/apimutex.h b/cpukit/include/rtems/score/apimutex.h
index a5aa2bf..e118269 100644
--- a/cpukit/include/rtems/score/apimutex.h
+++ b/cpukit/include/rtems/score/apimutex.h
@@ -28,8 +28,9 @@
* @ingroup RTEMSScore
*
* @brief Provides routines to ensure mutual exclusion on API level.
+ *
+ * @{
*/
-/**@{**/
#ifdef __cplusplus
extern "C" {
@@ -60,21 +61,21 @@ typedef struct {
/**
* @brief Acquires the specified API mutex.
*
- * @param[in] mutex The API mutex.
+ * @param[in, out] mutex The API mutex to acquire.
*/
void _API_Mutex_Lock( API_Mutex_Control *mutex );
/**
* @brief Releases the specified API mutex.
*
- * @param[in] mutex The API mutex.
+ * @param[in, out] mutex The API mutex to release.
*/
void _API_Mutex_Unlock( API_Mutex_Control *mutex );
/**
* @brief Checks if the specified API mutex is owned by the executing thread.
*
- * @param[in] mutex The API mutex.
+ * @param[in] mutex The API mutex to check the owner from.
*/
bool _API_Mutex_Is_owner( const API_Mutex_Control *mutex );
@@ -90,8 +91,9 @@ bool _API_Mutex_Is_owner( const API_Mutex_Control *mutex );
* When the APIs all use this for allocation and deallocation protection, then
* this possibly should be renamed and moved to a higher level in the
* hierarchy.
+ *
+ * @{
*/
-/**@{**/
void _RTEMS_Lock_allocator( void );
More information about the vc
mailing list