Doc: Format certain operators in text

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ö <topi.reinio@qt.io>
This commit is contained in:
Paul Wicking 2022-08-18 15:16:20 +02:00
parent 37bf3b883d
commit 767bac9c5e
14 changed files with 91 additions and 91 deletions

View File

@ -399,28 +399,28 @@ QT_BEGIN_NAMESPACE
/*! /*!
\fn template <typename T> QLEInteger &QLEInteger<T>::operator++() \fn template <typename T> QLEInteger &QLEInteger<T>::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. this object.
*/ */
/*! /*!
\fn template <typename T> QLEInteger QLEInteger<T>::operator++(int) \fn template <typename T> QLEInteger QLEInteger<T>::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. this object.
*/ */
/*! /*!
\fn template <typename T> QLEInteger &QLEInteger<T>::operator--() \fn template <typename T> QLEInteger &QLEInteger<T>::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. this object.
*/ */
/*! /*!
\fn template <typename T> QLEInteger QLEInteger<T>::operator--(int) \fn template <typename T> QLEInteger QLEInteger<T>::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. this object.
*/ */
@ -558,28 +558,28 @@ QT_BEGIN_NAMESPACE
/*! /*!
\fn template <typename T> QBEInteger &QBEInteger<T>::operator++() \fn template <typename T> QBEInteger &QBEInteger<T>::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. this object.
*/ */
/*! /*!
\fn template <typename T> QBEInteger QBEInteger<T>::operator++(int) \fn template <typename T> QBEInteger QBEInteger<T>::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. this object.
*/ */
/*! /*!
\fn template <typename T> QBEInteger &QBEInteger<T>::operator--() \fn template <typename T> QBEInteger &QBEInteger<T>::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. this object.
*/ */
/*! /*!
\fn template <typename T> QBEInteger QBEInteger<T>::operator--(int) \fn template <typename T> QBEInteger QBEInteger<T>::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. this object.
*/ */

View File

@ -151,7 +151,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\fn template<class Container> QIterator<Container> &QIterator<Container>::operator++() \fn template<class Container> QIterator<Container> &QIterator<Container>::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 next item in the container and returns an iterator to the new current
item. item.
@ -164,7 +164,7 @@ QT_BEGIN_NAMESPACE
\fn template<class Container> QIterator<Container> QIterator<Container>::operator++(int) \fn template<class Container> QIterator<Container> QIterator<Container>::operator++(int)
\overload \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 next item in the container and returns an iterator to the previously
current item. current item.
*/ */
@ -173,7 +173,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\fn template<class Container> QIterator<Container> &QIterator<Container>::operator--() \fn template<class Container> QIterator<Container> &QIterator<Container>::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. current and returns an iterator to the new current item.
Calling this function on QSequentialIterable::begin() leads to undefined results. Calling this function on QSequentialIterable::begin() leads to undefined results.
@ -189,7 +189,7 @@ QT_BEGIN_NAMESPACE
\overload \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. 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 If the container in the QVariant does not support bi-directional iteration, calling this function
@ -287,7 +287,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\fn template<class Container> QConstIterator<Container> &QConstIterator<Container>::operator++() \fn template<class Container> QConstIterator<Container> &QConstIterator<Container>::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 next item in the container and returns an iterator to the new current
item. item.
@ -301,7 +301,7 @@ QT_BEGIN_NAMESPACE
\overload \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 next item in the container and returns an iterator to the previously
current item. current item.
*/ */
@ -309,7 +309,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\fn template<class Container> QConstIterator<Container> &QConstIterator<Container>::operator--() \fn template<class Container> QConstIterator<Container> &QConstIterator<Container>::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. current and returns an iterator to the new current item.
Calling this function on QIterable<Container>::begin() leads to undefined results. Calling this function on QIterable<Container>::begin() leads to undefined results.
@ -325,7 +325,7 @@ QT_BEGIN_NAMESPACE
\overload \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. 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 If the container in the QVariant does not support bi-directional iteration, calling this function
@ -505,7 +505,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\fn template<class Iterator, typename IteratorCategory> QTaggedIterator<Iterator, IteratorCategory> &QTaggedIterator<Iterator, IteratorCategory>::operator++() \fn template<class Iterator, typename IteratorCategory> QTaggedIterator<Iterator, IteratorCategory> &QTaggedIterator<Iterator, IteratorCategory>::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 next item in the container and returns an iterator to the new current
item. item.
@ -518,7 +518,7 @@ QT_BEGIN_NAMESPACE
\fn template<class Iterator, typename IteratorCategory> QTaggedIterator<Iterator, IteratorCategory> QTaggedIterator<Iterator, IteratorCategory>::operator++(int) \fn template<class Iterator, typename IteratorCategory> QTaggedIterator<Iterator, IteratorCategory> QTaggedIterator<Iterator, IteratorCategory>::operator++(int)
\overload \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 next item in the container and returns an iterator to the previously
current item. current item.
*/ */
@ -527,7 +527,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\fn template<class Iterator, typename IteratorCategory> QTaggedIterator<Iterator, IteratorCategory> &QTaggedIterator<Iterator, IteratorCategory>::operator--() \fn template<class Iterator, typename IteratorCategory> QTaggedIterator<Iterator, IteratorCategory> &QTaggedIterator<Iterator, IteratorCategory>::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. current and returns an iterator to the new current item.
Calling this function on QSequentialIterable::begin() leads to undefined results. Calling this function on QSequentialIterable::begin() leads to undefined results.
@ -542,7 +542,7 @@ QT_BEGIN_NAMESPACE
\fn template<class Iterator, typename IteratorCategory> QTaggedIterator<Iterator, IteratorCategory> QTaggedIterator<Iterator, IteratorCategory>::operator--(int) \fn template<class Iterator, typename IteratorCategory> QTaggedIterator<Iterator, IteratorCategory> QTaggedIterator<Iterator, IteratorCategory>::operator--(int)
\overload \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. 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 If the container in the QVariant does not support bi-directional iteration, calling this function

View File

@ -847,7 +847,7 @@ void QCborArray::detach(qsizetype reserved)
/*! /*!
\fn QCborArray::Iterator &QCborArray::Iterator::operator++() \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. the array and returns this iterator.
Calling this function on QCborArray::end() leads to undefined results. 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) \fn QCborArray::Iterator QCborArray::Iterator::operator++(int)
\overload \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. in the array and returns an iterator to the previously current item.
*/ */
/*! /*!
\fn QCborArray::Iterator &QCborArray::Iterator::operator--() \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. returns this iterator.
Calling this function on QCborArray::begin() leads to undefined results. 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) \fn QCborArray::Iterator QCborArray::Iterator::operator--(int)
\overload \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. returns an iterator to the previously current item.
*/ */
@ -1087,7 +1087,7 @@ void QCborArray::detach(qsizetype reserved)
/*! /*!
\fn QCborArray::ConstIterator &QCborArray::ConstIterator::operator++() \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. the array and returns this iterator.
Calling this function on QCborArray::end() leads to undefined results. 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) \fn QCborArray::ConstIterator QCborArray::ConstIterator::operator++(int)
\overload \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. in the array and returns an iterator to the previously current item.
*/ */
/*! /*!
\fn QCborArray::ConstIterator &QCborArray::ConstIterator::operator--() \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. returns this iterator.
Calling this function on QCborArray::begin() leads to undefined results. 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) \fn QCborArray::ConstIterator QCborArray::ConstIterator::operator--(int)
\overload \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. returns an iterator to the previously current item.
*/ */

View File

@ -1349,7 +1349,7 @@ void QCborMap::detach(qsizetype reserved)
/*! /*!
\fn QCborMap::Iterator &QCborMap::Iterator::operator++() \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. the map and returns this iterator.
Calling this function on QCborMap::end() leads to undefined results. 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) \fn QCborMap::Iterator QCborMap::Iterator::operator++(int)
\overload \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. the map and returns an iterator to the previously current item.
*/ */
/*! /*!
\fn QCborMap::Iterator QCborMap::Iterator::operator--() \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. returns this iterator.
Calling this function on QCborMap::begin() leads to undefined results. 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) \fn QCborMap::Iterator QCborMap::Iterator::operator--(int)
\overload \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. returns an iterator pointing to the previously current item.
*/ */
@ -1594,7 +1594,7 @@ void QCborMap::detach(qsizetype reserved)
/*! /*!
\fn QCborMap::ConstIterator &QCborMap::ConstIterator::operator++() \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. the map and returns this iterator.
Calling this function on QCborMap::end() leads to undefined results. 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) \fn QCborMap::ConstIterator QCborMap::ConstIterator::operator++(int)
\overload \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. the map and returns an iterator to the previously current item.
*/ */
/*! /*!
\fn QCborMap::ConstIterator &QCborMap::ConstIterator::operator--() \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. returns this iterator.
Calling this function on QCborMap::begin() leads to undefined results. 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) \fn QCborMap::ConstIterator QCborMap::ConstIterator::operator--(int)
\overload \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. returns an iterator pointing to the previously current item.
*/ */

View File

@ -749,7 +749,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
/*! \fn QJsonArray::iterator &QJsonArray::iterator::operator++() /*! \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 next item in the array and returns an iterator to the new current
item. item.
@ -762,14 +762,14 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
\overload \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 next item in the array and returns an iterator to the previously
current item. current item.
*/ */
/*! \fn QJsonArray::iterator &QJsonArray::iterator::operator--() /*! \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. current and returns an iterator to the new current item.
Calling this function on QJsonArray::begin() leads to undefined results. Calling this function on QJsonArray::begin() leads to undefined results.
@ -781,7 +781,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
\overload \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. 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++() /*! \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 next item in the array and returns an iterator to the new current
item. item.
@ -978,14 +978,14 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
\overload \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 next item in the array and returns an iterator to the previously
current item. current item.
*/ */
/*! \fn QJsonArray::const_iterator &QJsonArray::const_iterator::operator--() /*! \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. current and returns an iterator to the new current item.
Calling this function on QJsonArray::begin() leads to undefined results. Calling this function on QJsonArray::begin() leads to undefined results.
@ -997,7 +997,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
\overload \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. current and returns an iterator to the previously current item.
*/ */

View File

@ -1020,7 +1020,7 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const
/*! \fn QJsonObject::iterator QJsonObject::iterator::operator++() /*! \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 next item in the object and returns an iterator to the new current
item. item.
@ -1033,14 +1033,14 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const
\overload \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 next item in the object and returns an iterator to the previously
current item. current item.
*/ */
/*! \fn QJsonObject::iterator QJsonObject::iterator::operator--() /*! \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. current and returns an iterator pointing to the new current item.
Calling this function on QJsonObject::begin() leads to undefined Calling this function on QJsonObject::begin() leads to undefined
@ -1053,7 +1053,7 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const
\overload \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 and returns an iterator pointing to the previously
current item. current item.
*/ */
@ -1260,7 +1260,7 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const
/*! \fn QJsonObject::const_iterator QJsonObject::const_iterator::operator++() /*! \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 next item in the object and returns an iterator to the new current
item. item.
@ -1273,14 +1273,14 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const
\overload \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 next item in the object and returns an iterator to the previously
current item. current item.
*/ */
/*! \fn QJsonObject::const_iterator &QJsonObject::const_iterator::operator--() /*! \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. current and returns an iterator pointing to the new current item.
Calling this function on QJsonObject::begin() leads to undefined Calling this function on QJsonObject::begin() leads to undefined
@ -1293,7 +1293,7 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const
\overload \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 and returns an iterator pointing to the previously
current item. current item.
*/ */

View File

@ -3351,8 +3351,8 @@ void QXmlStreamWriter::writeCharacters(const QString &text)
/*! Writes \a text as XML comment, where \a text must not contain the /*! Writes \a text as XML comment, where \a text must not contain the
forbidden sequence "--" or end with "-". Note that XML does not forbidden sequence \c{--} or end with \c{-}. Note that XML does not
provide any way to escape "-" in a comment. provide any way to escape \c{-} in a comment.
*/ */
void QXmlStreamWriter::writeComment(const QString &text) void QXmlStreamWriter::writeComment(const QString &text)
{ {

View File

@ -614,7 +614,7 @@
/*! \fn template <typename T> QFuture<T>::const_iterator &QFuture<T>::const_iterator::operator++() /*! \fn template <typename T> QFuture<T>::const_iterator &QFuture<T>::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. in the future and returns an iterator to the new current result.
Calling this function on QFuture<T>::constEnd() leads to undefined results. Calling this function on QFuture<T>::constEnd() leads to undefined results.
@ -626,14 +626,14 @@
\overload \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 in the future and returns an iterator to the previously current
result. result.
*/ */
/*! \fn template <typename T> QFuture<T>::const_iterator &QFuture<T>::const_iterator::operator--() /*! \fn template <typename T> QFuture<T>::const_iterator &QFuture<T>::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. returns an iterator to the new current result.
Calling this function on QFuture<T>::constBegin() leads to undefined results. Calling this function on QFuture<T>::constBegin() leads to undefined results.
@ -645,7 +645,7 @@
\overload \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. returns an iterator to the previously current result.
*/ */

View File

@ -84,7 +84,7 @@
/*! /*!
\fn template<typename Key, typename T, class Iterator> QKeyValueIterator &QKeyValueIterator<Key, T, Iterator>::operator++() \fn template<typename Key, typename T, class Iterator> QKeyValueIterator &QKeyValueIterator<Key, T, 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 container and returns the iterator. next item in the container and returns the iterator.
\note Advancing the iterator past its container's end() constitutes \note Advancing the iterator past its container's end() constitutes
@ -97,7 +97,7 @@
\overload \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. next item in the container and returns the iterator's prior value.
\note Advancing the iterator past its container's end() constitutes \note Advancing the iterator past its container's end() constitutes
@ -106,7 +106,7 @@
/*! \fn template<typename Key, typename T, class Iterator> QKeyValueIterator &QKeyValueIterator<Key, T, Iterator>::operator--() /*! \fn template<typename Key, typename T, class Iterator> QKeyValueIterator &QKeyValueIterator<Key, T, Iterator>::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. in the container and returns the iterator.
\note Backing up an iterator to before its container's begin() constitutes \note Backing up an iterator to before its container's begin() constitutes
@ -119,7 +119,7 @@
\overload \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. in the container and returns the iterator's prior value.
\note Backing up an iterator to before its container's begin() constitutes \note Backing up an iterator to before its container's begin() constitutes

View File

@ -989,7 +989,7 @@
/*! \fn template <class Key, class T> QMap<Key, T>::iterator &QMap<Key, T>::iterator::operator++() /*! \fn template <class Key, class T> QMap<Key, T>::iterator &QMap<Key, T>::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 next item in the map and returns an iterator to the new current
item. item.
@ -1002,14 +1002,14 @@
\overload \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 next item in the map and returns an iterator to the previously
current item. current item.
*/ */
/*! \fn template <class Key, class T> QMap<Key, T>::iterator &QMap<Key, T>::iterator::operator--() /*! \fn template <class Key, class T> QMap<Key, T>::iterator &QMap<Key, T>::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. current and returns an iterator pointing to the new current item.
Calling this function on QMap::begin() leads to undefined Calling this function on QMap::begin() leads to undefined
@ -1022,7 +1022,7 @@
\overload \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 and returns an iterator pointing to the previously
current item. current item.
*/ */
@ -1160,7 +1160,7 @@
/*! \fn template <class Key, class T> QMap<Key, T>::const_iterator &QMap<Key, T>::const_iterator::operator++() /*! \fn template <class Key, class T> QMap<Key, T>::const_iterator &QMap<Key, T>::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 next item in the map and returns an iterator to the new current
item. item.
@ -1173,14 +1173,14 @@
\overload \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 next item in the map and returns an iterator to the previously
current item. current item.
*/ */
/*! \fn template <class Key, class T> QMap<Key, T>::const_iterator &QMap<Key, T>::const_iterator::operator--() /*! \fn template <class Key, class T> QMap<Key, T>::const_iterator &QMap<Key, T>::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. current and returns an iterator pointing to the new current item.
Calling this function on QMap::begin() leads to undefined Calling this function on QMap::begin() leads to undefined
@ -1193,7 +1193,7 @@
\overload \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 and returns an iterator pointing to the previously
current item. current item.
*/ */
@ -1301,7 +1301,7 @@
/*! /*!
\fn template <class Key, class T> QMap<Key, T>::key_iterator &QMap<Key, T>::key_iterator::operator++() \fn template <class Key, class T> QMap<Key, T>::key_iterator &QMap<Key, T>::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 next item in the hash and returns an iterator to the new current
item. item.
@ -1314,14 +1314,14 @@
\overload \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 next item in the hash and returns an iterator to the previous
item. item.
*/ */
/*! \fn template <class Key, class T> QMap<Key, T>::key_iterator &QMap<Key, T>::key_iterator::operator--() /*! \fn template <class Key, class T> QMap<Key, T>::key_iterator &QMap<Key, T>::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. current and returns an iterator pointing to the new current item.
Calling this function on QMap::keyBegin() leads to undefined Calling this function on QMap::keyBegin() leads to undefined
@ -1334,7 +1334,7 @@
\overload \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 current and returns an iterator pointing to the previous
item. item.
*/ */

View File

@ -1142,7 +1142,7 @@
/*! \fn template <class Key, class T> QMultiMap<Key, T>::iterator &QMultiMap<Key, T>::iterator::operator++() /*! \fn template <class Key, class T> QMultiMap<Key, T>::iterator &QMultiMap<Key, T>::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 next item in the multi map and returns an iterator to the new current
item. item.
@ -1155,14 +1155,14 @@
\overload \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 next item in the multi map and returns an iterator to the previously
current item. current item.
*/ */
/*! \fn template <class Key, class T> QMultiMap<Key, T>::iterator &QMultiMap<Key, T>::iterator::operator--() /*! \fn template <class Key, class T> QMultiMap<Key, T>::iterator &QMultiMap<Key, T>::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. current and returns an iterator pointing to the new current item.
Calling this function on QMultiMap::begin() leads to undefined Calling this function on QMultiMap::begin() leads to undefined
@ -1175,7 +1175,7 @@
\overload \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 and returns an iterator pointing to the previously
current item. current item.
*/ */
@ -1316,7 +1316,7 @@
/*! \fn template <class Key, class T> QMultiMap<Key, T>::const_iterator &QMultiMap<Key, T>::const_iterator::operator++() /*! \fn template <class Key, class T> QMultiMap<Key, T>::const_iterator &QMultiMap<Key, T>::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 next item in the map and returns an iterator to the new current
item. item.
@ -1329,14 +1329,14 @@
\overload \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 next item in the map and returns an iterator to the previously
current item. current item.
*/ */
/*! \fn template <class Key, class T> QMultiMap<Key, T>::const_iterator &QMultiMap<Key, T>::const_iterator::operator--() /*! \fn template <class Key, class T> QMultiMap<Key, T>::const_iterator &QMultiMap<Key, T>::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. current and returns an iterator pointing to the new current item.
Calling this function on QMultiMap::begin() leads to undefined Calling this function on QMultiMap::begin() leads to undefined
@ -1349,7 +1349,7 @@
\overload \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 and returns an iterator pointing to the previously
current item. current item.
*/ */
@ -1458,7 +1458,7 @@
/*! /*!
\fn template <class Key, class T> QMultiMap<Key, T>::key_iterator &QMultiMap<Key, T>::key_iterator::operator++() \fn template <class Key, class T> QMultiMap<Key, T>::key_iterator &QMultiMap<Key, T>::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 next item in the hash and returns an iterator to the new current
item. item.
@ -1471,14 +1471,14 @@
\overload \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 next item in the hash and returns an iterator to the previous
item. item.
*/ */
/*! \fn template <class Key, class T> QMultiMap<Key, T>::key_iterator &QMultiMap<Key, T>::key_iterator::operator--() /*! \fn template <class Key, class T> QMultiMap<Key, T>::key_iterator &QMultiMap<Key, T>::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. current and returns an iterator pointing to the new current item.
Calling this function on QMultiMap::keyBegin() leads to undefined Calling this function on QMultiMap::keyBegin() leads to undefined
@ -1491,7 +1491,7 @@
\overload \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 current and returns an iterator pointing to the previous
item. item.
*/ */

View File

@ -337,14 +337,14 @@ QTextFrameLayoutData::~QTextFrameLayoutData()
/*! /*!
\fn QTextFrame::iterator QTextFrame::iterator::operator++(int) \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. next item in the text frame, and returns an iterator to the old item.
*/ */
/*! /*!
\fn QTextFrame::iterator QTextFrame::iterator::operator--(int) \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. current frame, and returns an iterator to the old item.
*/ */

View File

@ -513,7 +513,7 @@
the QObject::className() returns <namespace>::<classname>. This conflicts the QObject::className() returns <namespace>::<classname>. This conflicts
with the syntax for \l{Sub-Controls}. To overcome this problem, with the syntax for \l{Sub-Controls}. To overcome this problem,
when using the Type Selector for widgets inside namespaces, we must 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 \snippet code/doc_src_stylesheet.cpp 27

View File

@ -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. and returns a reference to the resulting iterator.
Sets the current pointer to \nullptr if the current item is the last matching item. 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. and returns a reference to the resulting iterator.
Sets the current pointer to \nullptr if the current item is the first matching item. Sets the current pointer to \nullptr if the current item is the first matching item.
*/ */