summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/include/rtems/posix/semaphore.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/posix/include/rtems/posix/semaphore.h')
-rw-r--r--cpukit/posix/include/rtems/posix/semaphore.h34
1 files changed, 18 insertions, 16 deletions
diff --git a/cpukit/posix/include/rtems/posix/semaphore.h b/cpukit/posix/include/rtems/posix/semaphore.h
index 08ace7684f..3127c3f9aa 100644
--- a/cpukit/posix/include/rtems/posix/semaphore.h
+++ b/cpukit/posix/include/rtems/posix/semaphore.h
@@ -1,5 +1,7 @@
/**
- * @file rtems/posix/semaphore.h
+ * @file
+ *
+ * @brief Private Support Information for POSIX Semaphores
*
* This include file contains all the private support information for
* POSIX Semaphores.
@@ -18,19 +20,18 @@
#define _RTEMS_POSIX_SEMAPHORE_H
/**
- * @defgroup POSIX_SEMAPHORES Semaphore
+ * @defgroup POSIXSemaphorePrivate POSIX Semaphore Private Support
+ *
+ * @ingroup POSIXAPI
*
- * @ingroup POSIX
+ * This defines the internal implementation support for POSIX semaphores.
*/
/**@{*/
+
#ifdef __cplusplus
extern "C" {
#endif
-/**
- * @ingroup POSIX_SEMAPHORE
- */
-
#include <semaphore.h>
#include <rtems/score/coresem.h>
#include <rtems/posix/posixapi.h>
@@ -145,25 +146,24 @@ int _POSIX_Semaphore_Create_support(
);
/**
- * @brief POSIX Delete Semaphore
+ * @brief POSIX delete a semaphore.
*
- * DESCRIPTION:
+ * DESCRIPTION:
*
- * This routine supports the sem_close and sem_unlink routines.
+ * This routine supports the sem_close and sem_unlink routines.
*/
void _POSIX_Semaphore_Delete(
POSIX_Semaphore_Control *the_semaphore
);
-/*
- * @brief POSIX Semaphore Wait Support
+/**
+ * @brief POSIX semaphore wait support.
*
- * DESCRIPTION:
+ * DESCRIPTION:
*
- * This routine supports the sem_wait, sem_trywait, and sem_timedwait
- * services.
+ * This routine supports the sem_wait, sem_trywait, and sem_timedwait
+ * services.
*/
-
int _POSIX_Semaphore_Wait_support(
sem_t *sem,
bool blocking,
@@ -189,5 +189,7 @@ int _POSIX_Semaphore_Translate_core_semaphore_return_code(
}
#endif
+/** @} */
+
#endif
/* end of include file */