diff options
author | Paul Wicking <paul.wicking@qt.io> | 2022-08-18 15:16:20 +0200 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2022-08-23 20:49:47 +0200 |
commit | 767bac9c5e48ee47e053c7370a8c9bdbe139a7d9 (patch) | |
tree | 3036796f473bb2d87d99616dee990c7f7f78aa68 /src/corelib/tools | |
parent | 37bf3b883d428d2fe0cae6513777d0c25c18d4ad (diff) |
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>
Diffstat (limited to 'src/corelib/tools')
-rw-r--r-- | src/corelib/tools/qiterator.qdoc | 8 | ||||
-rw-r--r-- | src/corelib/tools/qmap.qdoc | 24 | ||||
-rw-r--r-- | src/corelib/tools/qmultimap.qdoc | 24 |
3 files changed, 28 insertions, 28 deletions
diff --git a/src/corelib/tools/qiterator.qdoc b/src/corelib/tools/qiterator.qdoc index f4286c99ea..3fc68e0874 100644 --- a/src/corelib/tools/qiterator.qdoc +++ b/src/corelib/tools/qiterator.qdoc @@ -84,7 +84,7 @@ /*! \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. \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<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. \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 2e767acc4a..6aee94a8dc 100644 --- a/src/corelib/tools/qmap.qdoc +++ b/src/corelib/tools/qmap.qdoc @@ -989,7 +989,7 @@ /*! \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 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 <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. 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 <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 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 <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. 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 <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 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 <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. 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 f4751fdc45..c4b073bd94 100644 --- a/src/corelib/tools/qmultimap.qdoc +++ b/src/corelib/tools/qmultimap.qdoc @@ -1142,7 +1142,7 @@ /*! \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 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 <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. 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 <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 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 <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. 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 <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 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 <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. 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. */ |