summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/include/rtems/posix/spinlock.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/posix/include/rtems/posix/spinlock.h')
-rw-r--r--cpukit/posix/include/rtems/posix/spinlock.h36
1 files changed, 19 insertions, 17 deletions
diff --git a/cpukit/posix/include/rtems/posix/spinlock.h b/cpukit/posix/include/rtems/posix/spinlock.h
index 44061bd42c..34b04ebbc9 100644
--- a/cpukit/posix/include/rtems/posix/spinlock.h
+++ b/cpukit/posix/include/rtems/posix/spinlock.h
@@ -1,5 +1,7 @@
/**
- * @file rtems/posix/spinlock.h
+ * @file
+ *
+ * @brief POSIX Spinlock Support
*
* This include file contains all the constants and structures associated
* with the POSIX Spinlock Manager.
@@ -30,16 +32,18 @@ extern "C" {
/**
* @defgroup POSIX_SPINLOCK POSIX Spinlock Support
*
- * @ingroup POSIX
+ * @ingroup POSIXAPI
*
* @brief Constants and Structures Associated with the POSIX Spinlock Manager
+ *
*/
+/**@{**/
#include <rtems/score/object.h>
#include <rtems/score/corespinlock.h>
/**
- * This type defines the control block used to manage each spinlock.
+ * This type defines the control block used to manage each spinlock.
*/
typedef struct {
@@ -50,33 +54,29 @@ typedef struct {
} POSIX_Spinlock_Control;
/**
- * The following defines the information control block used to manage
- * this class of objects.
+ * The following defines the information control block used to manage
+ * this class of objects.
*/
POSIX_EXTERN Objects_Information _POSIX_Spinlock_Information;
/**
- * @brief _POSIX_Spinlock_Manager_initialization
+ * @brief POSIX spinlock manager initialization.
*
- * This routine performs the initialization necessary for this manager.
- *
- * @param[in] maximum_spinlocks is the total number of spinlocks allowed to
- * concurrently be active in the system.
+ * This routine performs the initialization necessary for this manager.
*/
void _POSIX_Spinlock_Manager_initialization(void);
/**
- * @brief POSIX Spinlock Translate Core Spinlock Return Code
- *
- * This routine translates SuperCore Spinlock status codes into the
- * corresponding POSIX ones.
+ * @brief Translate core spinlock status code.
*
+ * This routine translates SuperCore Spinlock status codes into the
+ * corresponding POSIX ones.
+ *
+ * @param[in] the_spinlock_status is the SuperCore status.
*
- * @param[in] the_spinlock_status is the SuperCore status.
- *
- * @return the corresponding POSIX status
+ * @return the corresponding POSIX status
*/
int _POSIX_Spinlock_Translate_core_spinlock_return_code(
CORE_spinlock_Status the_spinlock_status
@@ -86,6 +86,8 @@ int _POSIX_Spinlock_Translate_core_spinlock_return_code(
#include <rtems/posix/spinlock.inl>
#endif
+/** @} */
+
#ifdef __cplusplus
}
#endif