diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-07-25 08:48:55 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-07-26 07:18:29 +0200 |
| commit | 58840ffbb0c04dd19f0f532bf5b6e496159e070b (patch) | |
| tree | 9bb5dcc17158f35320933493dd4d6f4faf4317fc /cpukit/include/rtems/thread.h | |
| parent | libtest: Place files into a Doxygen group (diff) | |
| download | rtems-58840ffbb0c04dd19f0f532bf5b6e496159e070b.tar.bz2 | |
rtems: Add files to Doxygen groups
Provide basic Doxygen comments.
Update #3706.
Update #3707.
Diffstat (limited to 'cpukit/include/rtems/thread.h')
| -rw-r--r-- | cpukit/include/rtems/thread.h | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/cpukit/include/rtems/thread.h b/cpukit/include/rtems/thread.h index 739744b4e0..c3d7de67f4 100644 --- a/cpukit/include/rtems/thread.h +++ b/cpukit/include/rtems/thread.h @@ -1,5 +1,14 @@ /* SPDX-License-Identifier: BSD-2-Clause */ +/** + * @file + * + * @ingroup RTEMSAPISelfContainedObjects + * + * @brief This header file provides the API of + * @ref RTEMSAPISelfContainedObjects. + */ + /* * Copyright (c) 2017 embedded brains GmbH & Co. KG * @@ -45,6 +54,16 @@ void _Semaphore_Post_binary(struct _Semaphore_Control *); typedef struct _Mutex_Control rtems_mutex; +/** + * @defgroup RTEMSAPISelfContainedObjects Self-Contained Objects + * + * @ingroup RTEMSAPI + * + * @brief This group contains the self-contained objects API. + * + * @{ + */ + #define RTEMS_MUTEX_INITIALIZER( name ) _MUTEX_NAMED_INITIALIZER( name ) static __inline void rtems_mutex_init( rtems_mutex *mutex, const char *name ) @@ -309,6 +328,8 @@ static __inline void rtems_binary_semaphore_destroy( _Semaphore_Destroy( &binary_semaphore->Semaphore ); } +/** @} */ + __END_DECLS #endif /* _RTEMS_THREAD_H */ |