diff options
Diffstat (limited to 'src/corelib/tools/qsharedpointer.cpp')
| -rw-r--r-- | src/corelib/tools/qsharedpointer.cpp | 81 |
1 files changed, 35 insertions, 46 deletions
diff --git a/src/corelib/tools/qsharedpointer.cpp b/src/corelib/tools/qsharedpointer.cpp index b755941b73..39a71a4393 100644 --- a/src/corelib/tools/qsharedpointer.cpp +++ b/src/corelib/tools/qsharedpointer.cpp @@ -384,7 +384,7 @@ You can inherit this class when you need to create a QSharedPointer from any instance of a class; for instance, from within the object itself. The key point is that the technique of - just returning QSharedPointer<T>(this) can not be used, because + just returning QSharedPointer<T>(this) cannot be used, because this winds up creating multiple distinct QSharedPointer objects with separate reference counts. For this reason you must never create more than one QSharedPointer from the same raw pointer. @@ -406,7 +406,8 @@ /*! \fn template <class T> QSharedPointer<T>::QSharedPointer() - Creates a QSharedPointer that points to null (0). + Creates a QSharedPointer that is null (the object is holding + a reference to \nullptr). */ /*! @@ -552,6 +553,7 @@ Provides access to the shared pointer's members. + If the contained pointer is \nullptr, behavior is undefined. \sa isNull() */ @@ -560,21 +562,21 @@ Provides access to the shared pointer's members. + If the contained pointer is \nullptr, behavior is undefined. \sa isNull() */ /*! \fn template <class T> bool QSharedPointer<T>::isNull() const - Returns \c true if this object is holding a reference to a null - pointer. + Returns \c true if this object refers to \nullptr. */ /*! \fn template <class T> QSharedPointer<T>::operator bool() const - Returns \c true if this object is not null. This function is suitable - for use in \tt if-constructs, like: + Returns \c true if the contained pointer is not \nullptr. + This function is suitable for use in \tt if-constructs, like: \snippet code/src_corelib_tools_qsharedpointer.cpp 4 @@ -584,8 +586,8 @@ /*! \fn template <class T> bool QSharedPointer<T>::operator !() const - Returns \c true if this object is null. This function is suitable - for use in \tt if-constructs, like: + Returns \c true if this object refers to \nullptr. + This function is suitable for use in \tt if-constructs, like: \snippet code/src_corelib_tools_qsharedpointer.cpp 5 @@ -808,11 +810,10 @@ /*! \fn template <class T> bool QWeakPointer<T>::isNull() const - Returns \c true if this object is holding a reference to a null - pointer. + Returns \c true if this object refers to \nullptr. Note that, due to the nature of weak references, the pointer that - QWeakPointer references can become null at any moment, so + QWeakPointer references can become \nullptr at any moment, so the value returned from this function can change from false to true from one call to the next. */ @@ -820,13 +821,13 @@ /*! \fn template <class T> QWeakPointer<T>::operator bool() const - Returns \c true if this object is not null. This function is suitable - for use in \tt if-constructs, like: + Returns \c true if the contained pointer is not \nullptr. + This function is suitable for use in \tt if-constructs, like: \snippet code/src_corelib_tools_qsharedpointer.cpp 8 Note that, due to the nature of weak references, the pointer that - QWeakPointer references can become null at any moment, so + QWeakPointer references can become \nullptr at any moment, so the value returned from this function can change from true to false from one call to the next. @@ -836,13 +837,13 @@ /*! \fn template <class T> bool QWeakPointer<T>::operator !() const - Returns \c true if this object is null. This function is suitable - for use in \tt if-constructs, like: + Returns \c true if this object refers to \nullptr. + This function is suitable for use in \tt if-constructs, like: \snippet code/src_corelib_tools_qsharedpointer.cpp 9 Note that, due to the nature of weak references, the pointer that - QWeakPointer references can become null at any moment, so + QWeakPointer references can become \nullptr at any moment, so the value returned from this function can change from false to true from one call to the next. @@ -923,7 +924,7 @@ If \c this (that is, the subclass instance invoking this method) is being managed by a QSharedPointer, returns a shared pointer instance pointing to - \c this; otherwise returns a QSharedPointer holding a null pointer. + \c this; otherwise returns a null QSharedPointer. */ /*! @@ -938,8 +939,7 @@ \fn template <class T> template <class X> bool operator==(const QSharedPointer<T> &ptr1, const QSharedPointer<X> &ptr2) \relates QSharedPointer - Returns \c true if the pointer referenced by \a ptr1 is the - same pointer as that referenced by \a ptr2. + Returns \c true if \a ptr1 and \a ptr2 refer to the same pointer. If \a ptr2's template parameter is different from \a ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast @@ -952,8 +952,7 @@ \fn template <class T> template <class X> bool operator!=(const QSharedPointer<T> &ptr1, const QSharedPointer<X> &ptr2) \relates QSharedPointer - Returns \c true if the pointer referenced by \a ptr1 is not the - same pointer as that referenced by \a ptr2. + Returns \c true if \a ptr1 and \a ptr2 refer to distinct pointers. If \a ptr2's template parameter is different from \a ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast @@ -966,8 +965,7 @@ \fn template <class T> template <class X> bool operator==(const QSharedPointer<T> &ptr1, const X *ptr2) \relates QSharedPointer - Returns \c true if the pointer referenced by \a ptr1 is the - same pointer as \a ptr2. + Returns \c true if \a ptr1 and \a ptr2 refer to the same pointer. If \a ptr2's type is different from \a ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast @@ -980,8 +978,7 @@ \fn template <class T> template <class X> bool operator!=(const QSharedPointer<T> &ptr1, const X *ptr2) \relates QSharedPointer - Returns \c true if the pointer referenced by \a ptr1 is not the - same pointer as \a ptr2. + Returns \c true if \a ptr1 and \a ptr2 refer to distinct pointers. If \a ptr2's type is different from \a ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast @@ -1022,8 +1019,7 @@ \fn template <class T> template <class X> bool operator==(const QSharedPointer<T> &ptr1, const QWeakPointer<X> &ptr2) \relates QWeakPointer - Returns \c true if the pointer referenced by \a ptr1 is the - same pointer as that referenced by \a ptr2. + Returns \c true if \a ptr1 and \a ptr2 refer to the same pointer. If \a ptr2's template parameter is different from \a ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast @@ -1036,8 +1032,7 @@ \fn template <class T> template <class X> bool operator!=(const QSharedPointer<T> &ptr1, const QWeakPointer<X> &ptr2) \relates QWeakPointer - Returns \c true if the pointer referenced by \a ptr1 is not the - same pointer as that referenced by \a ptr2. + Returns \c true if \a ptr1 and \a ptr2 refer to distinct pointers. If \a ptr2's template parameter is different from \a ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast @@ -1050,8 +1045,7 @@ \fn template <class T> template <class X> bool operator==(const QWeakPointer<T> &ptr1, const QSharedPointer<X> &ptr2) \relates QWeakPointer - Returns \c true if the pointer referenced by \a ptr1 is the - same pointer as that referenced by \a ptr2. + Returns \c true if \a ptr1 and \a ptr2 refer to the same pointer. If \a ptr2's template parameter is different from \a ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast @@ -1065,7 +1059,7 @@ \relates QSharedPointer \since 5.8 - Returns \c true if the pointer referenced by \a lhs is a null pointer. + Returns \c true if \a lhs refers to \nullptr. \sa QSharedPointer::isNull() */ @@ -1075,7 +1069,7 @@ \relates QSharedPointer \since 5.8 - Returns \c true if the pointer referenced by \a rhs is a null pointer. + Returns \c true if \a rhs refers to \nullptr. \sa QSharedPointer::isNull() */ @@ -1085,8 +1079,7 @@ \relates QSharedPointer \since 5.8 - Returns \c true if the pointer referenced by \a lhs is a valid (i.e. - non-null) pointer. + Returns \c true if \a lhs refers to a valid (i.e. non-null) pointer. \sa QSharedPointer::isNull() */ @@ -1096,8 +1089,7 @@ \relates QSharedPointer \since 5.8 - Returns \c true if the pointer referenced by \a rhs is a valid (i.e. - non-null) pointer. + Returns \c true if \a rhs refers to a valid (i.e. non-null) pointer. \sa QSharedPointer::isNull() */ @@ -1107,7 +1099,7 @@ \relates QWeakPointer \since 5.8 - Returns \c true if the pointer referenced by \a lhs is a null pointer. + Returns \c true if \a lhs refers to \nullptr. \sa QWeakPointer::isNull() */ @@ -1117,7 +1109,7 @@ \relates QWeakPointer \since 5.8 - Returns \c true if the pointer referenced by \a rhs is a null pointer. + Returns \c true if \a rhs refers to \nullptr. \sa QWeakPointer::isNull() */ @@ -1127,8 +1119,7 @@ \relates QWeakPointer \since 5.8 - Returns \c true if the pointer referenced by \a lhs is a valid (i.e. - non-null) pointer. + Returns \c true if \a lhs refers to a valid (i.e. non-null) pointer. \sa QWeakPointer::isNull() */ @@ -1138,8 +1129,7 @@ \relates QWeakPointer \since 5.8 - Returns \c true if the pointer referenced by \a rhs is a valid (i.e. - non-null) pointer. + Returns \c true if \a rhs refers to a valid (i.e. non-null) pointer. \sa QWeakPointer::isNull() */ @@ -1148,8 +1138,7 @@ \fn template <class T> template <class X> bool operator!=(const QWeakPointer<T> &ptr1, const QSharedPointer<X> &ptr2) \relates QWeakPointer - Returns \c true if the pointer referenced by \a ptr1 is not the - same pointer as that referenced by \a ptr2. + Returns \c true if \a ptr1 and \a ptr2 refer to distinct pointers. If \a ptr2's template parameter is different from \a ptr1's, QSharedPointer will attempt to perform an automatic \tt static_cast |