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/coremutex.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/coremutex.h')
-rw-r--r-- | cpukit/include/rtems/score/coremutex.h | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/cpukit/include/rtems/score/coremutex.h b/cpukit/include/rtems/score/coremutex.h index af1eb0136e..2f65d6c8c0 100644 --- a/cpukit/include/rtems/score/coremutex.h +++ b/cpukit/include/rtems/score/coremutex.h @@ -3,12 +3,9 @@ * * @ingroup RTEMSScoreMutex * - * @brief CORE Mutex API - * - * This include file contains all the constants and structures associated with - * the Mutex Handler. A mutex is an enhanced version of the standard Dijkstra - * binary semaphore used to provide synchronization and mutual exclusion - * capabilities. + * @brief This header file provides interfaces of the + * @ref RTEMSScoreMutex which are used by the implementation and the + * @ref RTEMSImplApplConfig. */ /* @@ -43,7 +40,9 @@ extern "C" { * @brief This group contains the Mutex Handler implementation. * * This handler encapsulates functionality which provides the foundation - * Mutex services used in all of the APIs supported by RTEMS. + * Mutex services used in all of the APIs supported by RTEMS. A mutex is an + * enhanced version of the standard Dijkstra binary semaphore used to provide + * synchronization and mutual exclusion capabilities. * * @{ */ |