summaryrefslogtreecommitdiffstats
path: root/src/corelib/tools/qsharedpointer.cpp
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/tools/qsharedpointer.cpp
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff)
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 <oswald.buddenhagen@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/corelib/tools/qsharedpointer.cpp')
-rw-r--r--src/corelib/tools/qsharedpointer.cpp32
1 files changed, 16 insertions, 16 deletions
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<T> &ptr1, const QSharedPointer<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 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<T> &ptr1, const QSharedPointer<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 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<T> &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<T> &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<X> &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<X> &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<T> &ptr1, const QWeakPointer<X> &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<T> &ptr1, const QWeakPointer<X> &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<T> &ptr1, const QSharedPointer<X> &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<T> &ptr1, const QSharedPointer<X> &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,