diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-27 17:21:23 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-12-02 07:45:53 +0100 |
commit | 9278f3d04f1e26071cb98a5e2940177abc40b6d8 (patch) | |
tree | 9f5d198e4af5ad22b96012a17ce0a23769acf01f /cpukit/include/rtems/score/muteximpl.h | |
parent | rtems: Canonicalize Doxygen @file comments (diff) | |
download | rtems-9278f3d04f1e26071cb98a5e2940177abc40b6d8.tar.bz2 |
score: Canonicalize Doxygen @file comments
Use common phrases for the file brief descriptions.
Update #3706.
Diffstat (limited to 'cpukit/include/rtems/score/muteximpl.h')
-rw-r--r-- | cpukit/include/rtems/score/muteximpl.h | 25 |
1 files changed, 16 insertions, 9 deletions
diff --git a/cpukit/include/rtems/score/muteximpl.h b/cpukit/include/rtems/score/muteximpl.h index aac55faf03..c75a9ab657 100644 --- a/cpukit/include/rtems/score/muteximpl.h +++ b/cpukit/include/rtems/score/muteximpl.h @@ -1,9 +1,10 @@ /** * @file * - * @ingroup RTEMSScoreAPIMutex + * @ingroup RTEMSScoreSyslockMutex * - * @brief Structures for the implementation of mutexes. + * @brief This header file provides the interfaces of the + * @ref RTEMSScoreSyslockMutex. */ /* @@ -25,16 +26,22 @@ #include <rtems/score/threadqimpl.h> +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + /** - * @addtogroup RTEMSScoreAPIMutex + * @defgroup RTEMSScoreSyslockMutex System Lock Mutex Support + * + * @ingroup RTEMSScore + * + * @brief The System Lock Mutex Support helps to implement directives which use + * data structures compatible with the data structures defined by the Newlib + * provided <sys/lock.h> header file. * * @{ */ -#ifdef __cplusplus -extern "C" { -#endif /* __cplusplus */ - typedef struct { Thread_queue_Syslock_queue Queue; } Mutex_Control; @@ -44,10 +51,10 @@ typedef struct { unsigned int nest_level; } Mutex_recursive_Control; +/** @} */ + #ifdef __cplusplus } #endif /* __cplusplus */ -/** @} */ - #endif /* _RTEMS_SCORE_MUTEXIMPL_H */ |