QtBase: Doc: Fix links to STL-style iterators
authorDavid Schulz <david.schulz@digia.com>
Thu, 6 Dec 2012 08:49:07 +0000 (09:49 +0100)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Thu, 6 Dec 2012 13:46:13 +0000 (14:46 +0100)
Change-Id: I2822c2a7e9bfc1949c20ff81e08961f641e961fb
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
12 files changed:
src/corelib/doc/src/implicit-sharing.qdoc
src/corelib/json/qjsonarray.cpp
src/corelib/json/qjsonobject.cpp
src/corelib/thread/qfuture.qdoc
src/corelib/tools/qhash.cpp
src/corelib/tools/qlinkedlist.cpp
src/corelib/tools/qlist.cpp
src/corelib/tools/qmap.cpp
src/corelib/tools/qset.qdoc
src/corelib/tools/qstring.cpp
src/corelib/tools/qvarlengtharray.qdoc
src/corelib/tools/qvector.cpp

index 39ba702..baed85f 100644 (file)
 
     \warning Do not copy an implicitly shared container (QMap,
     QVector, etc.) while you are iterating over it using an non-const
-    \l{STL-style iterator}.
+    \l{STL-style iterators}{STL-style iterator}.
 
     \keyword implicitly shared classes
     \annotatedlist shared
index 0cd436a..a669a55 100644 (file)
@@ -535,7 +535,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
 
 /*! \fn QJsonArray::iterator QJsonArray::begin()
 
-    Returns an \l{STL-style iterator} pointing to the first item in
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in
     the array.
 
     \sa constBegin(), end()
@@ -548,7 +548,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
 
 /*! \fn QJsonArray::const_iterator QJsonArray::constBegin() const
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the array.
 
     \sa begin(), constEnd()
@@ -556,7 +556,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
 
 /*! \fn QJsonArray::iterator QJsonArray::end()
 
-    Returns an \l{STL-style iterator} pointing to the imaginary item
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item
     after the last item in the array.
 
     \sa begin(), constEnd()
@@ -569,7 +569,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
 
 /*! \fn QJsonArray::const_iterator QJsonArray::constEnd() const
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the array.
 
     \sa constBegin(), end()
index 728bbbd..e595753 100644 (file)
@@ -525,7 +525,7 @@ QJsonObject::const_iterator QJsonObject::constFind(const QString &key) const
 
 /*! \fn QJsonObject::iterator QJsonObject::begin()
 
-    Returns an \l{STL-style iterator} pointing to the first item in
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in
     the object.
 
     \sa constBegin(), end()
@@ -538,7 +538,7 @@ QJsonObject::const_iterator QJsonObject::constFind(const QString &key) const
 
 /*! \fn QJsonObject::const_iterator QJsonObject::constBegin() const
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the object.
 
     \sa begin(), constEnd()
@@ -546,7 +546,7 @@ QJsonObject::const_iterator QJsonObject::constFind(const QString &key) const
 
 /*! \fn QJsonObject::iterator QJsonObject::end()
 
-    Returns an \l{STL-style iterator} pointing to the imaginary item
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item
     after the last item in the object.
 
     \sa begin(), constEnd()
@@ -559,7 +559,7 @@ QJsonObject::const_iterator QJsonObject::constFind(const QString &key) const
 
 /*! \fn QJsonObject::const_iterator QJsonObject::constEnd() const
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the object.
 
     \sa constBegin(), end()
index b67d711..6ba5d56 100644 (file)
 
 /*! \fn QFuture::const_iterator QFuture::begin() const
 
-    Returns a const \l{STL-style iterator} pointing to the first result in the
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first result in the
     future.
 
     \sa constBegin(), end()
 
 /*! \fn QFuture::const_iterator QFuture::end() const
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary result
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary result
     after the last result in the future.
 
     \sa begin(), constEnd()
 
 /*! \fn QFuture::const_iterator QFuture::constBegin() const
 
-    Returns a const \l{STL-style iterator} pointing to the first result in the
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first result in the
     future.
 
     \sa begin(), constEnd()
 
 /*! \fn QFuture::const_iterator QFuture::constEnd() const
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary result
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary result
     after the last result in the future.
 
     \sa constBegin(), end()
index 3fab2f6..eca66d7 100644 (file)
@@ -1261,7 +1261,7 @@ void QHashData::checkSanity()
 
 /*! \fn QHash::iterator QHash::begin()
 
-    Returns an \l{STL-style iterator} pointing to the first item in
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in
     the hash.
 
     \sa constBegin(), end()
@@ -1275,7 +1275,7 @@ void QHashData::checkSanity()
 /*! \fn QHash::const_iterator QHash::cbegin() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the hash.
 
     \sa begin(), cend()
@@ -1283,7 +1283,7 @@ void QHashData::checkSanity()
 
 /*! \fn QHash::const_iterator QHash::constBegin() const
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the hash.
 
     \sa begin(), constEnd()
@@ -1291,7 +1291,7 @@ void QHashData::checkSanity()
 
 /*! \fn QHash::iterator QHash::end()
 
-    Returns an \l{STL-style iterator} pointing to the imaginary item
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item
     after the last item in the hash.
 
     \sa begin(), constEnd()
@@ -1304,7 +1304,7 @@ void QHashData::checkSanity()
 
 /*! \fn QHash::const_iterator QHash::constEnd() const
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the hash.
 
     \sa constBegin(), end()
@@ -1313,7 +1313,7 @@ void QHashData::checkSanity()
 /*! \fn QHash::const_iterator QHash::cend() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the hash.
 
     \sa cbegin(), end()
index 025d48b..0c5894f 100644 (file)
@@ -320,7 +320,7 @@ const QLinkedListData QLinkedListData::shared_null = {
 
 /*! \fn QLinkedList::iterator QLinkedList::begin()
 
-    Returns an \l{STL-style iterator} pointing to the first item in
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in
     the list.
 
     \sa constBegin(), end()
@@ -334,7 +334,7 @@ const QLinkedListData QLinkedListData::shared_null = {
 /*! \fn QLinkedList::const_iterator QLinkedList::cbegin() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the list.
 
     \sa begin(), cend()
@@ -342,7 +342,7 @@ const QLinkedListData QLinkedListData::shared_null = {
 
 /*! \fn QLinkedList::const_iterator QLinkedList::constBegin() const
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the list.
 
     \sa begin(), constEnd()
@@ -350,7 +350,7 @@ const QLinkedListData QLinkedListData::shared_null = {
 
 /*! \fn QLinkedList::iterator QLinkedList::end()
 
-    Returns an \l{STL-style iterator} pointing to the imaginary item
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item
     after the last item in the list.
 
     \sa begin(), constEnd()
@@ -364,7 +364,7 @@ const QLinkedListData QLinkedListData::shared_null = {
 /*! \fn QLinkedList::const_iterator QLinkedList::cend() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the list.
 
     \sa cbegin(), end()
@@ -372,7 +372,7 @@ const QLinkedListData QLinkedListData::shared_null = {
 
 /*! \fn QLinkedList::const_iterator QLinkedList::constEnd() const
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the list.
 
     \sa constBegin(), end()
index 4f26b25..f31b184 100644 (file)
@@ -915,7 +915,7 @@ void **QListData::erase(void **xi)
 
 /*! \fn QList::iterator QList::begin()
 
-    Returns an \l{STL-style iterator} pointing to the first item in
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in
     the list.
 
     \sa constBegin(), end()
@@ -929,7 +929,7 @@ void **QListData::erase(void **xi)
 /*! \fn QList::const_iterator QList::cbegin() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the list.
 
     \sa begin(), cend()
@@ -937,7 +937,7 @@ void **QListData::erase(void **xi)
 
 /*! \fn QList::const_iterator QList::constBegin() const
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the list.
 
     \sa begin(), constEnd()
@@ -945,7 +945,7 @@ void **QListData::erase(void **xi)
 
 /*! \fn QList::iterator QList::end()
 
-    Returns an \l{STL-style iterator} pointing to the imaginary item
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item
     after the last item in the list.
 
     \sa begin(), constEnd()
@@ -959,7 +959,7 @@ void **QListData::erase(void **xi)
 /*! \fn QList::const_iterator QList::cend() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the list.
 
     \sa cbegin(), end()
@@ -967,7 +967,7 @@ void **QListData::erase(void **xi)
 
 /*! \fn QList::const_iterator QList::constEnd() const
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the list.
 
     \sa constBegin(), end()
index 7c33d60..9f6b5f3 100644 (file)
@@ -811,7 +811,7 @@ void QMapDataBase::freeData(QMapDataBase *d)
 
 /*! \fn QMap::iterator QMap::begin()
 
-    Returns an \l{STL-style iterator} pointing to the first item in
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in
     the map.
 
     \sa constBegin(), end()
@@ -825,7 +825,7 @@ void QMapDataBase::freeData(QMapDataBase *d)
 /*! \fn QMap::const_iterator QMap::cbegin() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the map.
 
     \sa begin(), cend()
@@ -833,7 +833,7 @@ void QMapDataBase::freeData(QMapDataBase *d)
 
 /*! \fn QMap::const_iterator QMap::constBegin() const
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the map.
 
     \sa begin(), constEnd()
@@ -841,7 +841,7 @@ void QMapDataBase::freeData(QMapDataBase *d)
 
 /*! \fn QMap::iterator QMap::end()
 
-    Returns an \l{STL-style iterator} pointing to the imaginary item
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item
     after the last item in the map.
 
     \sa begin(), constEnd()
@@ -855,7 +855,7 @@ void QMapDataBase::freeData(QMapDataBase *d)
 /*! \fn QMap::const_iterator QMap::cend() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the map.
 
     \sa cbegin(), end()
@@ -863,7 +863,7 @@ void QMapDataBase::freeData(QMapDataBase *d)
 
 /*! \fn QMap::const_iterator QMap::constEnd() const
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the map.
 
     \sa constBegin(), end()
index 6649d5b..dc07f48 100644 (file)
 
 /*! \fn QSet::const_iterator QSet::begin() const
 
-    Returns a const \l{STL-style iterator} positioned at the first
+    Returns a const \l{STL-style iterators}{STL-style iterator} positioned at the first
     item in the set.
 
     \sa constBegin(), end()
     \since 4.2
     \overload
 
-    Returns a non-const \l{STL-style iterator} positioned at the first
+    Returns a non-const \l{STL-style iterators}{STL-style iterator} positioned at the first
     item in the set.  
 */
 
 /*! \fn QSet::const_iterator QSet::cbegin() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} positioned at the first
+    Returns a const \l{STL-style iterators}{STL-style iterator} positioned at the first
     item in the set.
 
     \sa begin(), cend()
 
 /*! \fn QSet::const_iterator QSet::constBegin() const
 
-    Returns a const \l{STL-style iterator} positioned at the first
+    Returns a const \l{STL-style iterators}{STL-style iterator} positioned at the first
     item in the set.
 
     \sa begin(), constEnd()
 
 /*! \fn QSet::const_iterator QSet::end() const
 
-    Returns a const \l{STL-style iterator} positioned at the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} positioned at the imaginary
     item after the last item in the set.
 
     \sa constEnd(), begin()
     \since 4.2
     \overload
 
-    Returns a non-const \l{STL-style iterator} pointing to the
+    Returns a non-const \l{STL-style iterators}{STL-style iterator} pointing to the
     imaginary item after the last item in the set.
 */
 
 /*! \fn QSet::const_iterator QSet::cend() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the set.
 
     \sa cbegin(), end()
 
 /*! \fn QSet::const_iterator QSet::constEnd() const
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the set.
 
     \sa constBegin(), end()
index 34a8cbe..6db4fed 100644 (file)
@@ -840,7 +840,7 @@ const QString::Null QString::null = { };
 
 /*! \fn QString::iterator QString::begin()
 
-    Returns an \l{STL-style iterator} pointing to the first character in
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first character in
     the string.
 
     \sa constBegin(), end()
@@ -854,7 +854,7 @@ const QString::Null QString::null = { };
 /*! \fn QString::const_iterator QString::cbegin() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the first character
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first character
     in the string.
 
     \sa begin(), cend()
@@ -862,7 +862,7 @@ const QString::Null QString::null = { };
 
 /*! \fn QString::const_iterator QString::constBegin() const
 
-    Returns a const \l{STL-style iterator} pointing to the first character
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first character
     in the string.
 
     \sa begin(), constEnd()
@@ -870,7 +870,7 @@ const QString::Null QString::null = { };
 
 /*! \fn QString::iterator QString::end()
 
-    Returns an \l{STL-style iterator} pointing to the imaginary character
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary character
     after the last character in the string.
 
     \sa begin(), constEnd()
@@ -884,7 +884,7 @@ const QString::Null QString::null = { };
 /*! \fn QString::const_iterator QString::cend() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the list.
 
     \sa cbegin(), end()
@@ -892,7 +892,7 @@ const QString::Null QString::null = { };
 
 /*! \fn QString::const_iterator QString::constEnd() const
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the list.
 
     \sa constBegin(), end()
index 452bc0a..0481373 100644 (file)
 /*! \fn QVarLengthArray::iterator QVarLengthArray::begin()
     \since 4.8
 
-    Returns an \l{STL-style iterator} pointing to the first item in
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in
     the array.
 
     \sa constBegin(), end()
 /*! \fn QVarLengthArray::const_iterator QVarLengthArray::cbegin() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the array.
 
     \sa begin(), cend()
 /*! \fn QVarLengthArray::const_iterator QVarLengthArray::constBegin() const
     \since 4.8
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the array.
 
     \sa begin(), constEnd()
 /*! \fn QVarLengthArray::iterator QVarLengthArray::end()
     \since 4.8
 
-    Returns an \l{STL-style iterator} pointing to the imaginary item
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item
     after the last item in the array.
 
     \sa begin(), constEnd()
 /*! \fn QVarLengthArray::const_iterator QVarLengthArray::cend() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the array.
 
     \sa cbegin(), end()
 /*! \fn QVarLengthArray::const_iterator QVarLengthArray::constEnd() const
     \since 4.8
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the array.
 
     \sa constBegin(), end()
index f33bb93..ab81271 100644 (file)
 
 /*! \fn QVector::iterator QVector::begin()
 
-    Returns an \l{STL-style iterator} pointing to the first item in
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in
     the vector.
 
     \sa constBegin(), end()
 /*! \fn QVector::const_iterator QVector::cbegin() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the vector.
 
     \sa begin(), cend()
 
 /*! \fn QVector::const_iterator QVector::constBegin() const
 
-    Returns a const \l{STL-style iterator} pointing to the first item
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item
     in the vector.
 
     \sa begin(), constEnd()
 
 /*! \fn QVector::iterator QVector::end()
 
-    Returns an \l{STL-style iterator} pointing to the imaginary item
+    Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item
     after the last item in the vector.
 
     \sa begin(), constEnd()
 /*! \fn QVector::const_iterator QVector::cend() const
     \since 5.0
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the vector.
 
     \sa cbegin(), end()
 
 /*! \fn QVector::const_iterator QVector::constEnd() const
 
-    Returns a const \l{STL-style iterator} pointing to the imaginary
+    Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary
     item after the last item in the vector.
 
     \sa constBegin(), end()