diff options
author | Thiago Macieira <thiago.macieira@intel.com> | 2012-12-11 14:24:05 -0800 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-12-12 01:17:27 +0100 |
commit | 4955cd8539dd23ad568daa1dad004677078d15c9 (patch) | |
tree | f8895fa1f8cf76955503e489a313ad6cef64e17d /src/corelib/thread/qatomic.cpp | |
parent | 817bec7a23cb8ee20947547eefa3b4cca70525c9 (diff) |
Document the new load / store methods in QAtomic{Int,Pointer}
Task-number: QTBUG-24627
Change-Id: Iaa2573aa8f0f36cac81efa73020c2f365bfcba53
Reviewed-by: Olivier Goffart <ogoffart@woboq.com>
Diffstat (limited to 'src/corelib/thread/qatomic.cpp')
-rw-r--r-- | src/corelib/thread/qatomic.cpp | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/src/corelib/thread/qatomic.cpp b/src/corelib/thread/qatomic.cpp index 791f41074d..ef74ac40e8 100644 --- a/src/corelib/thread/qatomic.cpp +++ b/src/corelib/thread/qatomic.cpp @@ -216,6 +216,44 @@ this QAtomicInt. */ +/*! + \fn int QAtomicInt::load() const + + Atomically loads the value of this QAtomicInt using relaxed memory + ordering. The value is not modified in any way, but note that there's no + guarantee that it remains so. + + \sa store(), loadAcquire() +*/ + +/*! + \fn int QAtomicInt::loadAcquire() const + + Atomically loads the value of this QAtomicInt using the "Acquire" memory + ordering. The value is not modified in any way, but note that there's no + guarantee that it remains so. + + \sa store(), load() +*/ + +/*! + \fn void QAtomicInt::store(int newValue) + + Atomically stores the \a newValue value into this atomic type, using + relaxed memory ordering. + + \sa storeRelease(), load() +*/ + +/*! + \fn void QAtomicInt::storeRelease(int newValue) + + Atomically stores the \a newValue value into this atomic type, using + the "Release" memory ordering. + + \sa store(), load() +*/ + /*! \fn bool QAtomicInt::isReferenceCountingNative() Returns true if reference counting is implemented using atomic @@ -750,6 +788,44 @@ this QAtomicPointer. */ +/*! + \fn T *QAtomicPointer::load() const + + Atomically loads the value of this QAtomicPointer using relaxed memory + ordering. The value is not modified in any way, but note that there's no + guarantee that it remains so. + + \sa store(), loadAcquire() +*/ + +/*! + \fn T *QAtomicPointer::loadAcquire() const + + Atomically loads the value of this QAtomicPointerusing the "Acquire" memory + ordering. The value is not modified in any way, but note that there's no + guarantee that it remains so. + + \sa store(), load() +*/ + +/*! + \fn void QAtomicPointer::store(T *newValue) + + Atomically stores the \a newValue value into this atomic type, using + relaxed memory ordering. + + \sa storeRelease(), load() +*/ + +/*! + \fn void QAtomicPointer::storeRelease(T *newValue) + + Atomically stores the \a newValue value into this atomic type, using + the "Release" memory ordering. + + \sa store(), load() +*/ + /*! \fn bool QAtomicPointer::isTestAndSetNative() Returns true if test-and-set is implemented using atomic processor |