diff options
| author | Petri Savolainen <petri.savolainen@nokia.com> | 2015-10-23 10:00:17 +0300 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2015-12-29 14:07:51 +0300 |
| commit | 0f8f4c6eb6ab0abdf6ce4480d2878a5618145e69 (patch) | |
| tree | 50be6e89a2ae969d5d37867069f0c6cefece6054 /include/odp/api/spinlock_recursive.h | |
| parent | 100423843b013a0d1f9ab5837cdafbea5d7c527c (diff) | |
api: doc: re-organize doxygen doc for synchronizer
Removed module synchronizer from doxygen documentation and
introduced new modules for locks, atomics and barriers. Removed
unnecessary group tagging from internal headers, which are not
visible to doxygen anyway.
Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com>
Reviewed-by: Mike Holmes <mike.holmes@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'include/odp/api/spinlock_recursive.h')
| -rw-r--r-- | include/odp/api/spinlock_recursive.h | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/include/odp/api/spinlock_recursive.h b/include/odp/api/spinlock_recursive.h index 46b6be762..d98f2bbb6 100644 --- a/include/odp/api/spinlock_recursive.h +++ b/include/odp/api/spinlock_recursive.h @@ -17,17 +17,20 @@ extern "C" { #endif -/** @addtogroup odp_synchronizers - * Operations on recursive spinlocks. - * @{ +/** + * @addtogroup odp_locks + * @details + * <b> Recursive spin lock (odp_spinlock_recursive_t) </b> + * + * This is recursive version of the spin lock. A thread can acquire the lock + * multiple times without a deadlock. To release the lock, the thread must + * unlock it the same number of times. + * @{ */ /** * @typedef odp_spinlock_recursive_t * Recursive spinlock - * - * A thread can acquire the lock multiple times without a deadlock. To release - * the lock, the thread must unlock it the same number of times. */ /** |