Doc: fix the type listed for the functions in QAtomicInteger
The "int" was a left over when this was documentation for QAtomicInt. Change-Id: If7b7688982d27cbbd42f080eff7d08344b587f44 Reviewed-by: Richard J. Moore <rich@kde.org>bb10
parent
9b869cfb01
commit
86ca4de8a2
|
|
@ -250,7 +250,7 @@
|
|||
|
||||
|
||||
/*!
|
||||
\fn int QAtomicInteger::load() const
|
||||
\fn T QAtomicInteger::load() const
|
||||
|
||||
Atomically loads the value of this QAtomicInteger using relaxed memory
|
||||
ordering. The value is not modified in any way, but note that there's no
|
||||
|
|
@ -260,7 +260,7 @@
|
|||
*/
|
||||
|
||||
/*!
|
||||
\fn int QAtomicInteger::loadAcquire() const
|
||||
\fn T QAtomicInteger::loadAcquire() const
|
||||
|
||||
Atomically loads the value of this QAtomicInteger using the "Acquire" memory
|
||||
ordering. The value is not modified in any way, but note that there's no
|
||||
|
|
@ -270,7 +270,7 @@
|
|||
*/
|
||||
|
||||
/*!
|
||||
\fn void QAtomicInteger::store(int newValue)
|
||||
\fn void QAtomicInteger::store(T newValue)
|
||||
|
||||
Atomically stores the \a newValue value into this atomic type, using
|
||||
relaxed memory ordering.
|
||||
|
|
@ -279,7 +279,7 @@
|
|||
*/
|
||||
|
||||
/*!
|
||||
\fn void QAtomicInteger::storeRelease(int newValue)
|
||||
\fn void QAtomicInteger::storeRelease(T newValue)
|
||||
|
||||
Atomically stores the \a newValue value into this atomic type, using
|
||||
the "Release" memory ordering.
|
||||
|
|
@ -288,7 +288,7 @@
|
|||
*/
|
||||
|
||||
/*!
|
||||
\fn QAtomicInteger::operator int() const
|
||||
\fn QAtomicInteger::operator T() const
|
||||
\since 5.3
|
||||
|
||||
Atomically loads the value of this QAtomicInteger using a sequentially
|
||||
|
|
@ -300,7 +300,7 @@
|
|||
*/
|
||||
|
||||
/*!
|
||||
\fn QAtomicInteger &QAtomicInteger::operator=(int newValue)
|
||||
\fn QAtomicInteger &QAtomicInteger::operator=(T newValue)
|
||||
\since 5.3
|
||||
|
||||
Atomically stores the \a newValue value into this atomic type using a
|
||||
|
|
@ -335,7 +335,7 @@
|
|||
*/
|
||||
|
||||
/*!
|
||||
\fn int QAtomicInteger::operator++()
|
||||
\fn T QAtomicInteger::operator++()
|
||||
\since 5.3
|
||||
|
||||
Atomically pre-increments the value of this QAtomicInteger. Returns the new
|
||||
|
|
@ -348,7 +348,7 @@
|
|||
*/
|
||||
|
||||
/*!
|
||||
\fn int QAtomicInteger::operator++(int)
|
||||
\fn T QAtomicInteger::operator++(int)
|
||||
\since 5.3
|
||||
|
||||
Atomically post-increments the value of this QAtomicInteger. Returns the old
|
||||
|
|
@ -373,7 +373,7 @@
|
|||
*/
|
||||
|
||||
/*!
|
||||
\fn int QAtomicInteger::operator--()
|
||||
\fn T QAtomicInteger::operator--()
|
||||
\since 5.3
|
||||
|
||||
Atomically pre-decrements the value of this QAtomicInteger. Returns the new
|
||||
|
|
@ -386,7 +386,7 @@
|
|||
*/
|
||||
|
||||
/*!
|
||||
\fn int QAtomicInteger::operator--(int)
|
||||
\fn T QAtomicInteger::operator--(int)
|
||||
\since 5.3
|
||||
|
||||
Atomically post-decrements the value of this QAtomicInteger. Returns the old
|
||||
|
|
@ -409,7 +409,7 @@
|
|||
Returns \c true if atomic test-and-set is wait-free, false otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicInteger::testAndSetRelaxed(int expectedValue, int newValue)
|
||||
/*! \fn bool QAtomicInteger::testAndSetRelaxed(T expectedValue, T newValue)
|
||||
|
||||
Atomic test-and-set.
|
||||
|
||||
|
|
@ -423,7 +423,7 @@
|
|||
processor to freely reorder memory accesses.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicInteger::testAndSetAcquire(int expectedValue, int newValue)
|
||||
/*! \fn bool QAtomicInteger::testAndSetAcquire(T expectedValue, T newValue)
|
||||
|
||||
Atomic test-and-set.
|
||||
|
||||
|
|
@ -438,7 +438,7 @@
|
|||
be re-ordered before the atomic operation.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicInteger::testAndSetRelease(int expectedValue, int newValue)
|
||||
/*! \fn bool QAtomicInteger::testAndSetRelease(T expectedValue, T newValue)
|
||||
|
||||
Atomic test-and-set.
|
||||
|
||||
|
|
@ -453,7 +453,7 @@
|
|||
re-ordered after the atomic operation.
|
||||
*/
|
||||
|
||||
/*! \fn bool QAtomicInteger::testAndSetOrdered(int expectedValue, int newValue)
|
||||
/*! \fn bool QAtomicInteger::testAndSetOrdered(T expectedValue, T newValue)
|
||||
|
||||
Atomic test-and-set.
|
||||
|
||||
|
|
@ -480,7 +480,7 @@
|
|||
otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndStoreRelaxed(int newValue)
|
||||
/*! \fn T QAtomicInteger::fetchAndStoreRelaxed(T newValue)
|
||||
|
||||
Atomic fetch-and-store.
|
||||
|
||||
|
|
@ -492,7 +492,7 @@
|
|||
processor to freely reorder memory accesses.
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndStoreAcquire(int newValue)
|
||||
/*! \fn T QAtomicInteger::fetchAndStoreAcquire(T newValue)
|
||||
|
||||
Atomic fetch-and-store.
|
||||
|
||||
|
|
@ -505,7 +505,7 @@
|
|||
be re-ordered before the atomic operation.
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndStoreRelease(int newValue)
|
||||
/*! \fn T QAtomicInteger::fetchAndStoreRelease(T newValue)
|
||||
|
||||
Atomic fetch-and-store.
|
||||
|
||||
|
|
@ -518,7 +518,7 @@
|
|||
re-ordered after the atomic operation.
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndStoreOrdered(int newValue)
|
||||
/*! \fn T QAtomicInteger::fetchAndStoreOrdered(T newValue)
|
||||
|
||||
Atomic fetch-and-store.
|
||||
|
||||
|
|
@ -543,7 +543,7 @@
|
|||
otherwise.
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndAddRelaxed(int valueToAdd)
|
||||
/*! \fn T QAtomicInteger::fetchAndAddRelaxed(T valueToAdd)
|
||||
|
||||
Atomic fetch-and-add.
|
||||
|
||||
|
|
@ -557,7 +557,7 @@
|
|||
\sa operator+=(), fetchAndSubRelaxed()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndAddAcquire(int valueToAdd)
|
||||
/*! \fn T QAtomicInteger::fetchAndAddAcquire(T valueToAdd)
|
||||
|
||||
Atomic fetch-and-add.
|
||||
|
||||
|
|
@ -572,7 +572,7 @@
|
|||
\sa operator+=(), fetchAndSubAcquire()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndAddRelease(int valueToAdd)
|
||||
/*! \fn T QAtomicInteger::fetchAndAddRelease(T valueToAdd)
|
||||
|
||||
Atomic fetch-and-add.
|
||||
|
||||
|
|
@ -587,7 +587,7 @@
|
|||
\sa operator+=(), fetchAndSubRelease()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndAddOrdered(int valueToAdd)
|
||||
/*! \fn T QAtomicInteger::fetchAndAddOrdered(T valueToAdd)
|
||||
|
||||
Atomic fetch-and-add.
|
||||
|
||||
|
|
@ -602,7 +602,7 @@
|
|||
\sa operator+=(), fetchAndSubOrdered()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::operator+=(int valueToAdd)
|
||||
/*! \fn T QAtomicInteger::operator+=(T valueToAdd)
|
||||
\since 5.3
|
||||
|
||||
Atomic add-and-fetch.
|
||||
|
|
@ -616,7 +616,7 @@
|
|||
\sa fetchAndAddOrdered(), operator-=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndSubRelaxed(int valueToSub)
|
||||
/*! \fn T QAtomicInteger::fetchAndSubRelaxed(T valueToSub)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-sub.
|
||||
|
|
@ -631,7 +631,7 @@
|
|||
\sa operator-=(), fetchAndAddRelaxed()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndSubAcquire(int valueToSub)
|
||||
/*! \fn T QAtomicInteger::fetchAndSubAcquire(T valueToSub)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-sub.
|
||||
|
|
@ -647,7 +647,7 @@
|
|||
\sa operator-=(), fetchAndAddAcquire()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndSubRelease(int valueToSub)
|
||||
/*! \fn T QAtomicInteger::fetchAndSubRelease(T valueToSub)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-sub.
|
||||
|
|
@ -663,7 +663,7 @@
|
|||
\sa operator-=(), fetchAndAddRelease()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndSubOrdered(int valueToSub)
|
||||
/*! \fn T QAtomicInteger::fetchAndSubOrdered(T valueToSub)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-sub.
|
||||
|
|
@ -679,7 +679,7 @@
|
|||
\sa operator-=(), fetchAndAddOrdered()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::operator-=(int valueToSub)
|
||||
/*! \fn T QAtomicInteger::operator-=(T valueToSub)
|
||||
\since 5.3
|
||||
|
||||
Atomic sub-and-fetch.
|
||||
|
|
@ -693,7 +693,7 @@
|
|||
\sa fetchAndSubOrdered(), operator+=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndOrRelaxed(int valueToOr)
|
||||
/*! \fn T QAtomicInteger::fetchAndOrRelaxed(T valueToOr)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-or.
|
||||
|
|
@ -708,7 +708,7 @@
|
|||
\sa operator|=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndOrAcquire(int valueToOr)
|
||||
/*! \fn T QAtomicInteger::fetchAndOrAcquire(T valueToOr)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-or.
|
||||
|
|
@ -724,7 +724,7 @@
|
|||
\sa operator|=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndOrRelease(int valueToOr)
|
||||
/*! \fn T QAtomicInteger::fetchAndOrRelease(T valueToOr)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-or.
|
||||
|
|
@ -740,7 +740,7 @@
|
|||
\sa operator|=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndOrOrdered(int valueToOr)
|
||||
/*! \fn T QAtomicInteger::fetchAndOrOrdered(T valueToOr)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-or.
|
||||
|
|
@ -756,7 +756,7 @@
|
|||
\sa operator|=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::operator|=(int valueToOr)
|
||||
/*! \fn T QAtomicInteger::operator|=(T valueToOr)
|
||||
\since 5.3
|
||||
|
||||
Atomic or-and-fetch.
|
||||
|
|
@ -770,7 +770,7 @@
|
|||
\sa fetchAndOrOrdered()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndXorRelaxed(int valueToXor)
|
||||
/*! \fn T QAtomicInteger::fetchAndXorRelaxed(T valueToXor)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-xor.
|
||||
|
|
@ -785,7 +785,7 @@
|
|||
\sa operator^=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndXorAcquire(int valueToXor)
|
||||
/*! \fn T QAtomicInteger::fetchAndXorAcquire(T valueToXor)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-xor.
|
||||
|
|
@ -801,7 +801,7 @@
|
|||
\sa operator^=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndXorRelease(int valueToXor)
|
||||
/*! \fn T QAtomicInteger::fetchAndXorRelease(T valueToXor)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-xor.
|
||||
|
|
@ -817,7 +817,7 @@
|
|||
\sa operator^=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndXorOrdered(int valueToXor)
|
||||
/*! \fn T QAtomicInteger::fetchAndXorOrdered(T valueToXor)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-xor.
|
||||
|
|
@ -833,7 +833,7 @@
|
|||
\sa operator^=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::operator^=(int valueToXor)
|
||||
/*! \fn T QAtomicInteger::operator^=(T valueToXor)
|
||||
\since 5.3
|
||||
|
||||
Atomic xor-and-fetch.
|
||||
|
|
@ -847,7 +847,7 @@
|
|||
\sa fetchAndXorOrdered()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndAndRelaxed(int valueToAnd)
|
||||
/*! \fn T QAtomicInteger::fetchAndAndRelaxed(T valueToAnd)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-and.
|
||||
|
|
@ -862,7 +862,7 @@
|
|||
\sa operator&=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndAndAcquire(int valueToAnd)
|
||||
/*! \fn T QAtomicInteger::fetchAndAndAcquire(T valueToAnd)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-and.
|
||||
|
|
@ -878,7 +878,7 @@
|
|||
\sa operator&=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndAndRelease(int valueToAnd)
|
||||
/*! \fn T QAtomicInteger::fetchAndAndRelease(T valueToAnd)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-and.
|
||||
|
|
@ -894,7 +894,7 @@
|
|||
\sa operator&=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::fetchAndAndOrdered(int valueToAnd)
|
||||
/*! \fn T QAtomicInteger::fetchAndAndOrdered(T valueToAnd)
|
||||
\since 5.3
|
||||
|
||||
Atomic fetch-and-and.
|
||||
|
|
@ -910,7 +910,7 @@
|
|||
\sa operator&=()
|
||||
*/
|
||||
|
||||
/*! \fn int QAtomicInteger::operator&=(int valueToAnd)
|
||||
/*! \fn T QAtomicInteger::operator&=(T valueToAnd)
|
||||
\since 5.3
|
||||
|
||||
Atomic add-and-fetch.
|
||||
|
|
|
|||
|
|
@ -76,13 +76,13 @@ public:
|
|||
}
|
||||
|
||||
#ifdef Q_QDOC
|
||||
int load() const;
|
||||
int loadAcquire() const;
|
||||
void store(int newValue);
|
||||
void storeRelease(int newValue);
|
||||
T load() const;
|
||||
T loadAcquire() const;
|
||||
void store(T newValue);
|
||||
void storeRelease(T newValue);
|
||||
|
||||
operator int() const;
|
||||
QAtomicInteger &operator=(int);
|
||||
operator T() const;
|
||||
QAtomicInteger &operator=(T);
|
||||
|
||||
static Q_DECL_CONSTEXPR bool isReferenceCountingNative();
|
||||
static Q_DECL_CONSTEXPR bool isReferenceCountingWaitFree();
|
||||
|
|
@ -93,56 +93,56 @@ public:
|
|||
static Q_DECL_CONSTEXPR bool isTestAndSetNative();
|
||||
static Q_DECL_CONSTEXPR bool isTestAndSetWaitFree();
|
||||
|
||||
bool testAndSetRelaxed(int expectedValue, int newValue);
|
||||
bool testAndSetAcquire(int expectedValue, int newValue);
|
||||
bool testAndSetRelease(int expectedValue, int newValue);
|
||||
bool testAndSetOrdered(int expectedValue, int newValue);
|
||||
bool testAndSetRelaxed(T expectedValue, T newValue);
|
||||
bool testAndSetAcquire(T expectedValue, T newValue);
|
||||
bool testAndSetRelease(T expectedValue, T newValue);
|
||||
bool testAndSetOrdered(T expectedValue, T newValue);
|
||||
|
||||
static Q_DECL_CONSTEXPR bool isFetchAndStoreNative();
|
||||
static Q_DECL_CONSTEXPR bool isFetchAndStoreWaitFree();
|
||||
|
||||
int fetchAndStoreRelaxed(int newValue);
|
||||
int fetchAndStoreAcquire(int newValue);
|
||||
int fetchAndStoreRelease(int newValue);
|
||||
int fetchAndStoreOrdered(int newValue);
|
||||
T fetchAndStoreRelaxed(T newValue);
|
||||
T fetchAndStoreAcquire(T newValue);
|
||||
T fetchAndStoreRelease(T newValue);
|
||||
T fetchAndStoreOrdered(T newValue);
|
||||
|
||||
static Q_DECL_CONSTEXPR bool isFetchAndAddNative();
|
||||
static Q_DECL_CONSTEXPR bool isFetchAndAddWaitFree();
|
||||
|
||||
int fetchAndAddRelaxed(int valueToAdd);
|
||||
int fetchAndAddAcquire(int valueToAdd);
|
||||
int fetchAndAddRelease(int valueToAdd);
|
||||
int fetchAndAddOrdered(int valueToAdd);
|
||||
T fetchAndAddRelaxed(T valueToAdd);
|
||||
T fetchAndAddAcquire(T valueToAdd);
|
||||
T fetchAndAddRelease(T valueToAdd);
|
||||
T fetchAndAddOrdered(T valueToAdd);
|
||||
|
||||
int fetchAndSubRelaxed(int valueToSub);
|
||||
int fetchAndSubAcquire(int valueToSub);
|
||||
int fetchAndSubRelease(int valueToSub);
|
||||
int fetchAndSubOrdered(int valueToSub);
|
||||
T fetchAndSubRelaxed(T valueToSub);
|
||||
T fetchAndSubAcquire(T valueToSub);
|
||||
T fetchAndSubRelease(T valueToSub);
|
||||
T fetchAndSubOrdered(T valueToSub);
|
||||
|
||||
int fetchAndOrRelaxed(int valueToOr);
|
||||
int fetchAndOrAcquire(int valueToOr);
|
||||
int fetchAndOrRelease(int valueToOr);
|
||||
int fetchAndOrOrdered(int valueToOr);
|
||||
T fetchAndOrRelaxed(T valueToOr);
|
||||
T fetchAndOrAcquire(T valueToOr);
|
||||
T fetchAndOrRelease(T valueToOr);
|
||||
T fetchAndOrOrdered(T valueToOr);
|
||||
|
||||
int fetchAndAndRelaxed(int valueToAnd);
|
||||
int fetchAndAndAcquire(int valueToAnd);
|
||||
int fetchAndAndRelease(int valueToAnd);
|
||||
int fetchAndAndOrdered(int valueToAnd);
|
||||
T fetchAndAndRelaxed(T valueToAnd);
|
||||
T fetchAndAndAcquire(T valueToAnd);
|
||||
T fetchAndAndRelease(T valueToAnd);
|
||||
T fetchAndAndOrdered(T valueToAnd);
|
||||
|
||||
int fetchAndXorRelaxed(int valueToXor);
|
||||
int fetchAndXorAcquire(int valueToXor);
|
||||
int fetchAndXorRelease(int valueToXor);
|
||||
int fetchAndXorOrdered(int valueToXor);
|
||||
T fetchAndXorRelaxed(T valueToXor);
|
||||
T fetchAndXorAcquire(T valueToXor);
|
||||
T fetchAndXorRelease(T valueToXor);
|
||||
T fetchAndXorOrdered(T valueToXor);
|
||||
|
||||
int operator++();
|
||||
int operator++(int);
|
||||
int operator--();
|
||||
int operator--(int);
|
||||
int operator+=(int value);
|
||||
int operator-=(int value);
|
||||
int operator|=(int value);
|
||||
int operator&=(int value);
|
||||
int operator^=(int value);
|
||||
T operator++();
|
||||
T operator++(int);
|
||||
T operator--();
|
||||
T operator--(int);
|
||||
T operator+=(T value);
|
||||
T operator-=(T value);
|
||||
T operator|=(T value);
|
||||
T operator&=(T value);
|
||||
T operator^=(T value);
|
||||
#endif
|
||||
};
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue