From 767bac9c5e48ee47e053c7370a8c9bdbe139a7d9 Mon Sep 17 00:00:00 2001 From: Paul Wicking Date: Thu, 18 Aug 2022 15:16:20 +0200 Subject: [PATCH] Doc: Format certain operators in text MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Use correct text formatting; this ensures e.g. the decrement operator isn't converted to an en dash in the docs. Apply to increment operator docs also for consistency. Task-number: QTBUG-105729 Change-Id: I5f126b90bc1d1b91d86e1f87c9b17a583841adb6 Reviewed-by: Topi Reiniö --- src/corelib/global/qendian.cpp | 16 ++++++------- src/corelib/kernel/qiterable.cpp | 24 +++++++++---------- src/corelib/serialization/qcborarray.cpp | 16 ++++++------- src/corelib/serialization/qcbormap.cpp | 16 ++++++------- src/corelib/serialization/qjsonarray.cpp | 16 ++++++------- src/corelib/serialization/qjsonobject.cpp | 16 ++++++------- src/corelib/serialization/qxmlstream.cpp | 4 ++-- src/corelib/thread/qfuture.qdoc | 8 +++---- src/corelib/tools/qiterator.qdoc | 8 +++---- src/corelib/tools/qmap.qdoc | 24 +++++++++---------- src/corelib/tools/qmultimap.qdoc | 24 +++++++++---------- src/gui/text/qtextobject.cpp | 4 ++-- .../src/widgets-and-layouts/stylesheet.qdoc | 2 +- .../itemviews/qtreewidgetitemiterator.cpp | 4 ++-- 14 files changed, 91 insertions(+), 91 deletions(-) diff --git a/src/corelib/global/qendian.cpp b/src/corelib/global/qendian.cpp index 041562fe01f..2fa7404507a 100644 --- a/src/corelib/global/qendian.cpp +++ b/src/corelib/global/qendian.cpp @@ -399,28 +399,28 @@ QT_BEGIN_NAMESPACE /*! \fn template QLEInteger &QLEInteger::operator++() - Performs a prefix ++ (increment) on this QLEInteger and returns a reference to + Performs a prefix \c{++} (increment) on this QLEInteger and returns a reference to this object. */ /*! \fn template QLEInteger QLEInteger::operator++(int) - Performs a postfix ++ (increment) on this QLEInteger and returns a reference to + Performs a postfix \c{++} (increment) on this QLEInteger and returns a reference to this object. */ /*! \fn template QLEInteger &QLEInteger::operator--() - Performs a prefix -- (decrement) on this QLEInteger and returns a reference to + Performs a prefix \c{--} (decrement) on this QLEInteger and returns a reference to this object. */ /*! \fn template QLEInteger QLEInteger::operator--(int) - Performs a postfix -- (decrement) on this QLEInteger and returns a reference to + Performs a postfix \c{--} (decrement) on this QLEInteger and returns a reference to this object. */ @@ -558,28 +558,28 @@ QT_BEGIN_NAMESPACE /*! \fn template QBEInteger &QBEInteger::operator++() - Performs a prefix ++ (increment) on this QBEInteger and returns a reference to + Performs a prefix \c{++} (increment) on this QBEInteger and returns a reference to this object. */ /*! \fn template QBEInteger QBEInteger::operator++(int) - Performs a postfix ++ (increment) on this QBEInteger and returns a reference to + Performs a postfix \c{++} (increment) on this QBEInteger and returns a reference to this object. */ /*! \fn template QBEInteger &QBEInteger::operator--() - Performs a prefix -- (decrement) on this QBEInteger and returns a reference to + Performs a prefix \c{--} (decrement) on this QBEInteger and returns a reference to this object. */ /*! \fn template QBEInteger QBEInteger::operator--(int) - Performs a postfix -- (decrement) on this QBEInteger and returns a reference to + Performs a postfix \c{--} (decrement) on this QBEInteger and returns a reference to this object. */ diff --git a/src/corelib/kernel/qiterable.cpp b/src/corelib/kernel/qiterable.cpp index b720154d36f..80715b23473 100644 --- a/src/corelib/kernel/qiterable.cpp +++ b/src/corelib/kernel/qiterable.cpp @@ -151,7 +151,7 @@ QT_BEGIN_NAMESPACE /*! \fn template QIterator &QIterator::operator++() - The prefix ++ operator (\c{++it}) advances the iterator to the + The prefix \c{++} operator (\c{++it}) advances the iterator to the next item in the container and returns an iterator to the new current item. @@ -164,7 +164,7 @@ QT_BEGIN_NAMESPACE \fn template QIterator QIterator::operator++(int) \overload - The postfix ++ operator (\c{it++}) advances the iterator to the + The postfix \c{++} operator (\c{it++}) advances the iterator to the next item in the container and returns an iterator to the previously current item. */ @@ -173,7 +173,7 @@ QT_BEGIN_NAMESPACE /*! \fn template QIterator &QIterator::operator--() - The prefix -- operator (\c{--it}) makes the preceding item + The prefix \c{--} operator (\c{--it}) makes the preceding item current and returns an iterator to the new current item. Calling this function on QSequentialIterable::begin() leads to undefined results. @@ -189,7 +189,7 @@ QT_BEGIN_NAMESPACE \overload - The postfix -- operator (\c{it--}) makes the preceding item + The postfix \c{--} operator (\c{it--}) makes the preceding item current and returns an iterator to the previously current item. If the container in the QVariant does not support bi-directional iteration, calling this function @@ -287,7 +287,7 @@ QT_BEGIN_NAMESPACE /*! \fn template QConstIterator &QConstIterator::operator++() - The prefix ++ operator (\c{++it}) advances the iterator to the + The prefix \c{++} operator (\c{++it}) advances the iterator to the next item in the container and returns an iterator to the new current item. @@ -301,7 +301,7 @@ QT_BEGIN_NAMESPACE \overload - The postfix ++ operator (\c{it++}) advances the iterator to the + The postfix \c{++} operator (\c{it++}) advances the iterator to the next item in the container and returns an iterator to the previously current item. */ @@ -309,7 +309,7 @@ QT_BEGIN_NAMESPACE /*! \fn template QConstIterator &QConstIterator::operator--() - The prefix -- operator (\c{--it}) makes the preceding item + The prefix \c{--} operator (\c{--it}) makes the preceding item current and returns an iterator to the new current item. Calling this function on QIterable::begin() leads to undefined results. @@ -325,7 +325,7 @@ QT_BEGIN_NAMESPACE \overload - The postfix -- operator (\c{it--}) makes the preceding item + The postfix \c{--} operator (\c{it--}) makes the preceding item current and returns an iterator to the previously current item. If the container in the QVariant does not support bi-directional iteration, calling this function @@ -505,7 +505,7 @@ QT_BEGIN_NAMESPACE /*! \fn template QTaggedIterator &QTaggedIterator::operator++() - The prefix ++ operator (\c{++it}) advances the iterator to the + The prefix \c{++} operator (\c{++it}) advances the iterator to the next item in the container and returns an iterator to the new current item. @@ -518,7 +518,7 @@ QT_BEGIN_NAMESPACE \fn template QTaggedIterator QTaggedIterator::operator++(int) \overload - The postfix ++ operator (\c{it++}) advances the iterator to the + The postfix \c{++} operator (\c{it++}) advances the iterator to the next item in the container and returns an iterator to the previously current item. */ @@ -527,7 +527,7 @@ QT_BEGIN_NAMESPACE /*! \fn template QTaggedIterator &QTaggedIterator::operator--() - The prefix -- operator (\c{--it}) makes the preceding item + The prefix \c{--} operator (\c{--it}) makes the preceding item current and returns an iterator to the new current item. Calling this function on QSequentialIterable::begin() leads to undefined results. @@ -542,7 +542,7 @@ QT_BEGIN_NAMESPACE \fn template QTaggedIterator QTaggedIterator::operator--(int) \overload - The postfix -- operator (\c{it--}) makes the preceding item + The postfix \c{--} operator (\c{it--}) makes the preceding item current and returns an iterator to the previously current item. If the container in the QVariant does not support bi-directional iteration, calling this function diff --git a/src/corelib/serialization/qcborarray.cpp b/src/corelib/serialization/qcborarray.cpp index e9d31b4cc3a..1c8d21af47f 100644 --- a/src/corelib/serialization/qcborarray.cpp +++ b/src/corelib/serialization/qcborarray.cpp @@ -847,7 +847,7 @@ void QCborArray::detach(qsizetype reserved) /*! \fn QCborArray::Iterator &QCborArray::Iterator::operator++() - The prefix ++ operator, \c{++it}, advances the iterator to the next item in + The prefix \c{++} operator, \c{++it}, advances the iterator to the next item in the array and returns this iterator. Calling this function on QCborArray::end() leads to undefined results. @@ -859,14 +859,14 @@ void QCborArray::detach(qsizetype reserved) \fn QCborArray::Iterator QCborArray::Iterator::operator++(int) \overload - The postfix ++ operator, \c{it++}, advances the iterator to the next item + The postfix \c{++} operator, \c{it++}, advances the iterator to the next item in the array and returns an iterator to the previously current item. */ /*! \fn QCborArray::Iterator &QCborArray::Iterator::operator--() - The prefix -- operator, \c{--it}, makes the preceding item current and + The prefix \c{--} operator, \c{--it}, makes the preceding item current and returns this iterator. Calling this function on QCborArray::begin() leads to undefined results. @@ -878,7 +878,7 @@ void QCborArray::detach(qsizetype reserved) \fn QCborArray::Iterator QCborArray::Iterator::operator--(int) \overload - The postfix -- operator, \c{it--}, makes the preceding item current and + The postfix \c{--} operator, \c{it--}, makes the preceding item current and returns an iterator to the previously current item. */ @@ -1087,7 +1087,7 @@ void QCborArray::detach(qsizetype reserved) /*! \fn QCborArray::ConstIterator &QCborArray::ConstIterator::operator++() - The prefix ++ operator, \c{++it}, advances the iterator to the next item in + The prefix \c{++} operator, \c{++it}, advances the iterator to the next item in the array and returns this iterator. Calling this function on QCborArray::end() leads to undefined results. @@ -1099,14 +1099,14 @@ void QCborArray::detach(qsizetype reserved) \fn QCborArray::ConstIterator QCborArray::ConstIterator::operator++(int) \overload - The postfix ++ operator, \c{it++}, advances the iterator to the next item + The postfix \c{++} operator, \c{it++}, advances the iterator to the next item in the array and returns an iterator to the previously current item. */ /*! \fn QCborArray::ConstIterator &QCborArray::ConstIterator::operator--() - The prefix -- operator, \c{--it}, makes the preceding item current and + The prefix \c{--} operator, \c{--it}, makes the preceding item current and returns this iterator. Calling this function on QCborArray::begin() leads to undefined results. @@ -1118,7 +1118,7 @@ void QCborArray::detach(qsizetype reserved) \fn QCborArray::ConstIterator QCborArray::ConstIterator::operator--(int) \overload - The postfix -- operator, \c{it--}, makes the preceding item current and + The postfix \c{--} operator, \c{it--}, makes the preceding item current and returns an iterator to the previously current item. */ diff --git a/src/corelib/serialization/qcbormap.cpp b/src/corelib/serialization/qcbormap.cpp index 050565d5aec..b3b9ea2691d 100644 --- a/src/corelib/serialization/qcbormap.cpp +++ b/src/corelib/serialization/qcbormap.cpp @@ -1349,7 +1349,7 @@ void QCborMap::detach(qsizetype reserved) /*! \fn QCborMap::Iterator &QCborMap::Iterator::operator++() - The prefix ++ operator, \c{++i}, advances the iterator to the next item in + The prefix \c{++} operator, \c{++i}, advances the iterator to the next item in the map and returns this iterator. Calling this function on QCborMap::end() leads to undefined results. @@ -1361,14 +1361,14 @@ void QCborMap::detach(qsizetype reserved) \fn QCborMap::Iterator QCborMap::Iterator::operator++(int) \overload - The postfix ++ operator, \c{i++}, advances the iterator to the next item in + The postfix \c{++} operator, \c{i++}, advances the iterator to the next item in the map and returns an iterator to the previously current item. */ /*! \fn QCborMap::Iterator QCborMap::Iterator::operator--() - The prefix -- operator, \c{--i}, makes the preceding item current and + The prefix \c{--} operator, \c{--i}, makes the preceding item current and returns this iterator. Calling this function on QCborMap::begin() leads to undefined results. @@ -1380,7 +1380,7 @@ void QCborMap::detach(qsizetype reserved) \fn QCborMap::Iterator QCborMap::Iterator::operator--(int) \overload - The postfix -- operator, \c{i--}, makes the preceding item current and + The postfix \c{--} operator, \c{i--}, makes the preceding item current and returns an iterator pointing to the previously current item. */ @@ -1594,7 +1594,7 @@ void QCborMap::detach(qsizetype reserved) /*! \fn QCborMap::ConstIterator &QCborMap::ConstIterator::operator++() - The prefix ++ operator, \c{++i}, advances the iterator to the next item in + The prefix \c{++} operator, \c{++i}, advances the iterator to the next item in the map and returns this iterator. Calling this function on QCborMap::end() leads to undefined results. @@ -1606,14 +1606,14 @@ void QCborMap::detach(qsizetype reserved) \fn QCborMap::ConstIterator QCborMap::ConstIterator::operator++(int) \overload - The postfix ++ operator, \c{i++}, advances the iterator to the next item in + The postfix \c{++} operator, \c{i++}, advances the iterator to the next item in the map and returns an iterator to the previously current item. */ /*! \fn QCborMap::ConstIterator &QCborMap::ConstIterator::operator--() - The prefix -- operator, \c{--i}, makes the preceding item current and + The prefix \c{--} operator, \c{--i}, makes the preceding item current and returns this iterator. Calling this function on QCborMap::begin() leads to undefined results. @@ -1625,7 +1625,7 @@ void QCborMap::detach(qsizetype reserved) \fn QCborMap::ConstIterator QCborMap::ConstIterator::operator--(int) \overload - The postfix -- operator, \c{i--}, makes the preceding item current and + The postfix \c{--} operator, \c{i--}, makes the preceding item current and returns an iterator pointing to the previously current item. */ diff --git a/src/corelib/serialization/qjsonarray.cpp b/src/corelib/serialization/qjsonarray.cpp index 33f4d51b5fb..e9914e35646 100644 --- a/src/corelib/serialization/qjsonarray.cpp +++ b/src/corelib/serialization/qjsonarray.cpp @@ -749,7 +749,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const /*! \fn QJsonArray::iterator &QJsonArray::iterator::operator++() - The prefix ++ operator, \c{++it}, advances the iterator to the + The prefix \c{++} operator, \c{++it}, advances the iterator to the next item in the array and returns an iterator to the new current item. @@ -762,14 +762,14 @@ bool QJsonArray::operator!=(const QJsonArray &other) const \overload - The postfix ++ operator, \c{it++}, advances the iterator to the + The postfix \c{++} operator, \c{it++}, advances the iterator to the next item in the array and returns an iterator to the previously current item. */ /*! \fn QJsonArray::iterator &QJsonArray::iterator::operator--() - The prefix -- operator, \c{--it}, makes the preceding item + The prefix \c{--} operator, \c{--it}, makes the preceding item current and returns an iterator to the new current item. Calling this function on QJsonArray::begin() leads to undefined results. @@ -781,7 +781,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const \overload - The postfix -- operator, \c{it--}, makes the preceding item + The postfix \c{--} operator, \c{it--}, makes the preceding item current and returns an iterator to the previously current item. */ @@ -965,7 +965,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const /*! \fn QJsonArray::const_iterator &QJsonArray::const_iterator::operator++() - The prefix ++ operator, \c{++it}, advances the iterator to the + The prefix \c{++} operator, \c{++it}, advances the iterator to the next item in the array and returns an iterator to the new current item. @@ -978,14 +978,14 @@ bool QJsonArray::operator!=(const QJsonArray &other) const \overload - The postfix ++ operator, \c{it++}, advances the iterator to the + The postfix \c{++} operator, \c{it++}, advances the iterator to the next item in the array and returns an iterator to the previously current item. */ /*! \fn QJsonArray::const_iterator &QJsonArray::const_iterator::operator--() - The prefix -- operator, \c{--it}, makes the preceding item + The prefix \c{--} operator, \c{--it}, makes the preceding item current and returns an iterator to the new current item. Calling this function on QJsonArray::begin() leads to undefined results. @@ -997,7 +997,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const \overload - The postfix -- operator, \c{it--}, makes the preceding item + The postfix \c{--} operator, \c{it--}, makes the preceding item current and returns an iterator to the previously current item. */ diff --git a/src/corelib/serialization/qjsonobject.cpp b/src/corelib/serialization/qjsonobject.cpp index 7737244a2c6..1fdcbef829b 100644 --- a/src/corelib/serialization/qjsonobject.cpp +++ b/src/corelib/serialization/qjsonobject.cpp @@ -1020,7 +1020,7 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const /*! \fn QJsonObject::iterator QJsonObject::iterator::operator++() - The prefix ++ operator, \c{++i}, advances the iterator to the + The prefix \c{++} operator, \c{++i}, advances the iterator to the next item in the object and returns an iterator to the new current item. @@ -1033,14 +1033,14 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const \overload - The postfix ++ operator, \c{i++}, advances the iterator to the + The postfix \c{++} operator, \c{i++}, advances the iterator to the next item in the object and returns an iterator to the previously current item. */ /*! \fn QJsonObject::iterator QJsonObject::iterator::operator--() - The prefix -- operator, \c{--i}, makes the preceding item + The prefix \c{--} operator, \c{--i}, makes the preceding item current and returns an iterator pointing to the new current item. Calling this function on QJsonObject::begin() leads to undefined @@ -1053,7 +1053,7 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const \overload - The postfix -- operator, \c{i--}, makes the preceding item + The postfix \c{--} operator, \c{i--}, makes the preceding item current and returns an iterator pointing to the previously current item. */ @@ -1260,7 +1260,7 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const /*! \fn QJsonObject::const_iterator QJsonObject::const_iterator::operator++() - The prefix ++ operator, \c{++i}, advances the iterator to the + The prefix \c{++} operator, \c{++i}, advances the iterator to the next item in the object and returns an iterator to the new current item. @@ -1273,14 +1273,14 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const \overload - The postfix ++ operator, \c{i++}, advances the iterator to the + The postfix \c{++} operator, \c{i++}, advances the iterator to the next item in the object and returns an iterator to the previously current item. */ /*! \fn QJsonObject::const_iterator &QJsonObject::const_iterator::operator--() - The prefix -- operator, \c{--i}, makes the preceding item + The prefix \c{--} operator, \c{--i}, makes the preceding item current and returns an iterator pointing to the new current item. Calling this function on QJsonObject::begin() leads to undefined @@ -1293,7 +1293,7 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const \overload - The postfix -- operator, \c{i--}, makes the preceding item + The postfix \c{--} operator, \c{i--}, makes the preceding item current and returns an iterator pointing to the previously current item. */ diff --git a/src/corelib/serialization/qxmlstream.cpp b/src/corelib/serialization/qxmlstream.cpp index adc87b30a72..eb3ce46a06d 100644 --- a/src/corelib/serialization/qxmlstream.cpp +++ b/src/corelib/serialization/qxmlstream.cpp @@ -3351,8 +3351,8 @@ void QXmlStreamWriter::writeCharacters(const QString &text) /*! Writes \a text as XML comment, where \a text must not contain the - forbidden sequence "--" or end with "-". Note that XML does not - provide any way to escape "-" in a comment. + forbidden sequence \c{--} or end with \c{-}. Note that XML does not + provide any way to escape \c{-} in a comment. */ void QXmlStreamWriter::writeComment(const QString &text) { diff --git a/src/corelib/thread/qfuture.qdoc b/src/corelib/thread/qfuture.qdoc index cac5513e04b..570f7de8e37 100644 --- a/src/corelib/thread/qfuture.qdoc +++ b/src/corelib/thread/qfuture.qdoc @@ -614,7 +614,7 @@ /*! \fn template QFuture::const_iterator &QFuture::const_iterator::operator++() - The prefix ++ operator (\c{++it}) advances the iterator to the next result + The prefix \c{++} operator (\c{++it}) advances the iterator to the next result in the future and returns an iterator to the new current result. Calling this function on QFuture::constEnd() leads to undefined results. @@ -626,14 +626,14 @@ \overload - The postfix ++ operator (\c{it++}) advances the iterator to the next + The postfix \c{++} operator (\c{it++}) advances the iterator to the next result in the future and returns an iterator to the previously current result. */ /*! \fn template QFuture::const_iterator &QFuture::const_iterator::operator--() - The prefix -- operator (\c{--it}) makes the preceding result current and + The prefix \c{--} operator (\c{--it}) makes the preceding result current and returns an iterator to the new current result. Calling this function on QFuture::constBegin() leads to undefined results. @@ -645,7 +645,7 @@ \overload - The postfix -- operator (\c{it--}) makes the preceding result current and + The postfix \c{--} operator (\c{it--}) makes the preceding result current and returns an iterator to the previously current result. */ diff --git a/src/corelib/tools/qiterator.qdoc b/src/corelib/tools/qiterator.qdoc index f4286c99ea9..3fc68e08741 100644 --- a/src/corelib/tools/qiterator.qdoc +++ b/src/corelib/tools/qiterator.qdoc @@ -84,7 +84,7 @@ /*! \fn template QKeyValueIterator &QKeyValueIterator::operator++() - The prefix ++ operator (\c{++i}) advances the iterator to the + The prefix \c{++} operator (\c{++i}) advances the iterator to the next item in the container and returns the iterator. \note Advancing the iterator past its container's end() constitutes @@ -97,7 +97,7 @@ \overload - The postfix ++ operator (\c{i++}) advances the iterator to the + The postfix \c{++} operator (\c{i++}) advances the iterator to the next item in the container and returns the iterator's prior value. \note Advancing the iterator past its container's end() constitutes @@ -106,7 +106,7 @@ /*! \fn template QKeyValueIterator &QKeyValueIterator::operator--() - The prefix -- operator (\c{--i}) backs the iterator up to the previous item + The prefix c{--} operator (\c{--i}) backs the iterator up to the previous item in the container and returns the iterator. \note Backing up an iterator to before its container's begin() constitutes @@ -119,7 +119,7 @@ \overload - The postfix -- operator (\c{i--}) backs the iterator up to the previous item + The postfix c{--} operator (\c{i--}) backs the iterator up to the previous item in the container and returns the iterator's prior value. \note Backing up an iterator to before its container's begin() constitutes diff --git a/src/corelib/tools/qmap.qdoc b/src/corelib/tools/qmap.qdoc index 2e767acc4a0..6aee94a8dca 100644 --- a/src/corelib/tools/qmap.qdoc +++ b/src/corelib/tools/qmap.qdoc @@ -989,7 +989,7 @@ /*! \fn template QMap::iterator &QMap::iterator::operator++() - The prefix ++ operator (\c{++i}) advances the iterator to the + The prefix \c{++} operator (\c{++i}) advances the iterator to the next item in the map and returns an iterator to the new current item. @@ -1002,14 +1002,14 @@ \overload - The postfix ++ operator (\c{i++}) advances the iterator to the + The postfix \c{++} operator (\c{i++}) advances the iterator to the next item in the map and returns an iterator to the previously current item. */ /*! \fn template QMap::iterator &QMap::iterator::operator--() - The prefix -- operator (\c{--i}) makes the preceding item + The prefix \c{--} operator (\c{--i}) makes the preceding item current and returns an iterator pointing to the new current item. Calling this function on QMap::begin() leads to undefined @@ -1022,7 +1022,7 @@ \overload - The postfix -- operator (\c{i--}) makes the preceding item + The postfix \c{--} operator (\c{i--}) makes the preceding item current and returns an iterator pointing to the previously current item. */ @@ -1160,7 +1160,7 @@ /*! \fn template QMap::const_iterator &QMap::const_iterator::operator++() - The prefix ++ operator (\c{++i}) advances the iterator to the + The prefix \c{++} operator (\c{++i}) advances the iterator to the next item in the map and returns an iterator to the new current item. @@ -1173,14 +1173,14 @@ \overload - The postfix ++ operator (\c{i++}) advances the iterator to the + The postfix \c{++} operator (\c{i++}) advances the iterator to the next item in the map and returns an iterator to the previously current item. */ /*! \fn template QMap::const_iterator &QMap::const_iterator::operator--() - The prefix -- operator (\c{--i}) makes the preceding item + The prefix \c{--} operator (\c{--i}) makes the preceding item current and returns an iterator pointing to the new current item. Calling this function on QMap::begin() leads to undefined @@ -1193,7 +1193,7 @@ \overload - The postfix -- operator (\c{i--}) makes the preceding item + The postfix \c{--} operator (\c{i--}) makes the preceding item current and returns an iterator pointing to the previously current item. */ @@ -1301,7 +1301,7 @@ /*! \fn template QMap::key_iterator &QMap::key_iterator::operator++() - The prefix ++ operator (\c{++i}) advances the iterator to the + The prefix \c{++} operator (\c{++i}) advances the iterator to the next item in the hash and returns an iterator to the new current item. @@ -1314,14 +1314,14 @@ \overload - The postfix ++ operator (\c{i++}) advances the iterator to the + The postfix \c{++} operator (\c{i++}) advances the iterator to the next item in the hash and returns an iterator to the previous item. */ /*! \fn template QMap::key_iterator &QMap::key_iterator::operator--() - The prefix -- operator (\c{--i}) makes the preceding item + The prefix \c{--} operator (\c{--i}) makes the preceding item current and returns an iterator pointing to the new current item. Calling this function on QMap::keyBegin() leads to undefined @@ -1334,7 +1334,7 @@ \overload - The postfix -- operator (\c{i--}) makes the preceding item + The postfix \c{--} operator (\c{i--}) makes the preceding item current and returns an iterator pointing to the previous item. */ diff --git a/src/corelib/tools/qmultimap.qdoc b/src/corelib/tools/qmultimap.qdoc index f4751fdc452..c4b073bd949 100644 --- a/src/corelib/tools/qmultimap.qdoc +++ b/src/corelib/tools/qmultimap.qdoc @@ -1142,7 +1142,7 @@ /*! \fn template QMultiMap::iterator &QMultiMap::iterator::operator++() - The prefix ++ operator (\c{++i}) advances the iterator to the + The prefix \c{++} operator (\c{++i}) advances the iterator to the next item in the multi map and returns an iterator to the new current item. @@ -1155,14 +1155,14 @@ \overload - The postfix ++ operator (\c{i++}) advances the iterator to the + The postfix \c{++} operator (\c{i++}) advances the iterator to the next item in the multi map and returns an iterator to the previously current item. */ /*! \fn template QMultiMap::iterator &QMultiMap::iterator::operator--() - The prefix -- operator (\c{--i}) makes the preceding item + The prefix \c{--} operator (\c{--i}) makes the preceding item current and returns an iterator pointing to the new current item. Calling this function on QMultiMap::begin() leads to undefined @@ -1175,7 +1175,7 @@ \overload - The postfix -- operator (\c{i--}) makes the preceding item + The postfix \c{--} operator (\c{i--}) makes the preceding item current and returns an iterator pointing to the previously current item. */ @@ -1316,7 +1316,7 @@ /*! \fn template QMultiMap::const_iterator &QMultiMap::const_iterator::operator++() - The prefix ++ operator (\c{++i}) advances the iterator to the + The prefix \c{++} operator (\c{++i}) advances the iterator to the next item in the map and returns an iterator to the new current item. @@ -1329,14 +1329,14 @@ \overload - The postfix ++ operator (\c{i++}) advances the iterator to the + The postfix \c{++} operator (\c{i++}) advances the iterator to the next item in the map and returns an iterator to the previously current item. */ /*! \fn template QMultiMap::const_iterator &QMultiMap::const_iterator::operator--() - The prefix -- operator (\c{--i}) makes the preceding item + The prefix \c{--} operator (\c{--i}) makes the preceding item current and returns an iterator pointing to the new current item. Calling this function on QMultiMap::begin() leads to undefined @@ -1349,7 +1349,7 @@ \overload - The postfix -- operator (\c{i--}) makes the preceding item + The postfix \c{--} operator (\c{i--}) makes the preceding item current and returns an iterator pointing to the previously current item. */ @@ -1458,7 +1458,7 @@ /*! \fn template QMultiMap::key_iterator &QMultiMap::key_iterator::operator++() - The prefix ++ operator (\c{++i}) advances the iterator to the + The prefix \c{++} operator (\c{++i}) advances the iterator to the next item in the hash and returns an iterator to the new current item. @@ -1471,14 +1471,14 @@ \overload - The postfix ++ operator (\c{i++}) advances the iterator to the + The postfix \c{++} operator (\c{i++}) advances the iterator to the next item in the hash and returns an iterator to the previous item. */ /*! \fn template QMultiMap::key_iterator &QMultiMap::key_iterator::operator--() - The prefix -- operator (\c{--i}) makes the preceding item + The prefix \c{--} operator (\c{--i}) makes the preceding item current and returns an iterator pointing to the new current item. Calling this function on QMultiMap::keyBegin() leads to undefined @@ -1491,7 +1491,7 @@ \overload - The postfix -- operator (\c{i--}) makes the preceding item + The postfix \c{--} operator (\c{i--}) makes the preceding item current and returns an iterator pointing to the previous item. */ diff --git a/src/gui/text/qtextobject.cpp b/src/gui/text/qtextobject.cpp index 7cf9d36a897..1a201969f0b 100644 --- a/src/gui/text/qtextobject.cpp +++ b/src/gui/text/qtextobject.cpp @@ -337,14 +337,14 @@ QTextFrameLayoutData::~QTextFrameLayoutData() /*! \fn QTextFrame::iterator QTextFrame::iterator::operator++(int) - The postfix ++ operator (\c{i++}) advances the iterator to the + The postfix \c{++} operator (\c{i++}) advances the iterator to the next item in the text frame, and returns an iterator to the old item. */ /*! \fn QTextFrame::iterator QTextFrame::iterator::operator--(int) - The postfix -- operator (\c{i--}) makes the preceding item in the + The postfix \c{--} operator (\c{i--}) makes the preceding item in the current frame, and returns an iterator to the old item. */ diff --git a/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc b/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc index 9c5d8d5fe2b..46c28c5fc44 100644 --- a/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc @@ -513,7 +513,7 @@ the QObject::className() returns ::. This conflicts with the syntax for \l{Sub-Controls}. To overcome this problem, when using the Type Selector for widgets inside namespaces, we must - replace the "::" with "--". For example, + replace the \c{::} with \c{--}. For example, \snippet code/doc_src_stylesheet.cpp 27 diff --git a/src/widgets/itemviews/qtreewidgetitemiterator.cpp b/src/widgets/itemviews/qtreewidgetitemiterator.cpp index c4c3c316ad8..1dd677e209e 100644 --- a/src/widgets/itemviews/qtreewidgetitemiterator.cpp +++ b/src/widgets/itemviews/qtreewidgetitemiterator.cpp @@ -132,7 +132,7 @@ QTreeWidgetItemIterator &QTreeWidgetItemIterator::operator=(const QTreeWidgetIte } /*! - The prefix ++ operator (++it) advances the iterator to the next matching item + The prefix \c{++} operator (\c{++it}) advances the iterator to the next matching item and returns a reference to the resulting iterator. Sets the current pointer to \nullptr if the current item is the last matching item. */ @@ -147,7 +147,7 @@ QTreeWidgetItemIterator &QTreeWidgetItemIterator::operator++() } /*! - The prefix -- operator (--it) advances the iterator to the previous matching item + The prefix \c{--} operator (\c{--it}) advances the iterator to the previous matching item and returns a reference to the resulting iterator. Sets the current pointer to \nullptr if the current item is the first matching item. */