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/rwlock.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/rwlock.h')
| -rw-r--r-- | include/odp/api/rwlock.h | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/include/odp/api/rwlock.h b/include/odp/api/rwlock.h index d730a7014..54f426fe7 100644 --- a/include/odp/api/rwlock.h +++ b/include/odp/api/rwlock.h @@ -17,18 +17,21 @@ extern "C" { #endif -/** @defgroup odp_synchronizers ODP SYNCRONIZERS - * Operations on reader/writer locks. - * A reader/writer lock allows multiple simultaneous readers but only one - * writer at a time. - * A thread that wants write access will have to wait until there are no - * threads that want read access. This casues a risk for starvation. - * @{ +/** + * @defgroup odp_locks ODP LOCKS + * @details + * <b> Reader / writer lock (odp_rwlock_t) </b> + * + * A reader/writer lock allows multiple simultaneous readers but only one + * writer at a time. A thread that wants write access will have to wait until + * there are no threads that want read access. This casues a risk for + * starvation. + * @{ */ /** * @typedef odp_rwlock_t - * ODP rwlock + * ODP reader/writer lock */ |