From 4533cc994484a2308297e64e99af005fb4dca065 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 2 Oct 2013 16:51:05 +0200 Subject: Doc: Adding mark-up to boolean default values. Default values should have mark-up to denote that they are code. This commit changes: -"property is true" to "property is \c true". -"Returns true" to "Returns \c true". -"property is false" to "property is \c false". -"returns true" to "returns \c true". -"returns false" to "returns \c false". src/3rdparty and non-documentation instances were ignored. Task-number: QTBUG-33360 Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e Reviewed-by: Oswald Buddenhagen Reviewed-by: Jerome Pasion --- src/corelib/tools/qsharedpointer.cpp | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) (limited to 'src/corelib/tools/qsharedpointer.cpp') diff --git a/src/corelib/tools/qsharedpointer.cpp b/src/corelib/tools/qsharedpointer.cpp index ef62621386..77409f5c71 100644 --- a/src/corelib/tools/qsharedpointer.cpp +++ b/src/corelib/tools/qsharedpointer.cpp @@ -506,14 +506,14 @@ /*! \fn bool QSharedPointer::isNull() const - Returns true if this object is holding a reference to a null + Returns \c true if this object is holding a reference to a null pointer. */ /*! \fn QSharedPointer::operator bool() const - Returns true if this object is not null. This function is suitable + Returns \c true if this object is not null. This function is suitable for use in \tt if-constructs, like: \code @@ -526,7 +526,7 @@ /*! \fn bool QSharedPointer::operator !() const - Returns true if this object is null. This function is suitable + Returns \c true if this object is null. This function is suitable for use in \tt if-constructs, like: \code @@ -765,7 +765,7 @@ /*! \fn bool QWeakPointer::isNull() const - Returns true if this object is holding a reference to a null + Returns \c true if this object is holding a reference to a null pointer. Note that, due to the nature of weak references, the pointer that @@ -777,7 +777,7 @@ /*! \fn QWeakPointer::operator bool() const - Returns true if this object is not null. This function is suitable + Returns \c true if this object is not null. This function is suitable for use in \tt if-constructs, like: \code @@ -795,7 +795,7 @@ /*! \fn bool QWeakPointer::operator !() const - Returns true if this object is null. This function is suitable + Returns \c true if this object is null. This function is suitable for use in \tt if-constructs, like: \code @@ -896,7 +896,7 @@ \fn bool operator==(const QSharedPointer &ptr1, const QSharedPointer &ptr2) \relates QSharedPointer - Returns true if the pointer referenced by \a ptr1 is the + Returns \c true if the pointer referenced by \a ptr1 is the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, @@ -910,7 +910,7 @@ \fn bool operator!=(const QSharedPointer &ptr1, const QSharedPointer &ptr2) \relates QSharedPointer - Returns true if the pointer referenced by \a ptr1 is not the + Returns \c true if the pointer referenced by \a ptr1 is not the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, @@ -924,7 +924,7 @@ \fn bool operator==(const QSharedPointer &ptr1, const X *ptr2) \relates QSharedPointer - Returns true if the pointer referenced by \a ptr1 is the + Returns \c true if the pointer referenced by \a ptr1 is the same pointer as \a ptr2. If \a ptr2's type is different from \a ptr1's, @@ -938,7 +938,7 @@ \fn bool operator!=(const QSharedPointer &ptr1, const X *ptr2) \relates QSharedPointer - Returns true if the pointer referenced by \a ptr1 is not the + Returns \c true if the pointer referenced by \a ptr1 is not the same pointer as \a ptr2. If \a ptr2's type is different from \a ptr1's, @@ -952,7 +952,7 @@ \fn bool operator==(const T *ptr1, const QSharedPointer &ptr2) \relates QSharedPointer - Returns true if the pointer \a ptr1 is the + Returns \c true if the pointer \a ptr1 is the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's type, @@ -966,7 +966,7 @@ \fn bool operator!=(const T *ptr1, const QSharedPointer &ptr2) \relates QSharedPointer - Returns true if the pointer \a ptr1 is not the + Returns \c true if the pointer \a ptr1 is not the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's type, @@ -980,7 +980,7 @@ \fn bool operator==(const QSharedPointer &ptr1, const QWeakPointer &ptr2) \relates QWeakPointer - Returns true if the pointer referenced by \a ptr1 is the + Returns \c true if the pointer referenced by \a ptr1 is the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, @@ -994,7 +994,7 @@ \fn bool operator!=(const QSharedPointer &ptr1, const QWeakPointer &ptr2) \relates QWeakPointer - Returns true if the pointer referenced by \a ptr1 is not the + Returns \c true if the pointer referenced by \a ptr1 is not the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, @@ -1008,7 +1008,7 @@ \fn bool operator==(const QWeakPointer &ptr1, const QSharedPointer &ptr2) \relates QWeakPointer - Returns true if the pointer referenced by \a ptr1 is the + Returns \c true if the pointer referenced by \a ptr1 is the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, @@ -1022,7 +1022,7 @@ \fn bool operator!=(const QWeakPointer &ptr1, const QSharedPointer &ptr2) \relates QWeakPointer - Returns true if the pointer referenced by \a ptr1 is not the + Returns \c true if the pointer referenced by \a ptr1 is not the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, -- cgit v1.2.3