AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Fix documentation for deprecated QSet functions

Browse Source 
QDoc has trouble applying the \obsolete command for multiple
topic (\fn) commands in one go. Separate them out and expand
the reasoning for deprecation.

Mark the rest of the deprecated functions and typedefs related
to reverse iterators as \obsolete.

Change-Id: I09858efd7e1e5fc890d4f3f063f00c8812fc0b52
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Topi Reinio 2020-03-17 21:21:24 +01:00
parent 5a7a590e8a
commit 737e7524e8
1 changed files with 80 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
src/corelib/tools/qset.qdoc
View File

@ -399,6 +399,7 @@
*/ */
/*! \fn template <class T> QSet<T>::reverse_iterator QSet<T>::rbegin() /*! \fn template <class T> QSet<T>::reverse_iterator QSet<T>::rbegin()
\obsolete Deprecated in order to align with std::unordered_set functionality.
\since 5.6 \since 5.6
Returns a \l{STL-style iterators}{STL-style} reverse iterator pointing to the first Returns a \l{STL-style iterators}{STL-style} reverse iterator pointing to the first
@ -408,11 +409,13 @@
*/ */
/*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::rbegin() const /*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::rbegin() const
\obsolete Deprecated in order to align with std::unordered_set functionality.
\since 5.6 \since 5.6
\overload \overload
*/ */
/*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::crbegin() const /*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::crbegin() const
\obsolete Deprecated in order to align with std::unordered_set functionality.
\since 5.6 \since 5.6
Returns a const \l{STL-style iterators}{STL-style} reverse iterator pointing to the first Returns a const \l{STL-style iterators}{STL-style} reverse iterator pointing to the first
@ -422,6 +425,7 @@
*/ */
/*! \fn template <class T> QSet<T>::reverse_iterator QSet<T>::rend() /*! \fn template <class T> QSet<T>::reverse_iterator QSet<T>::rend()
\obsolete Deprecated in order to align with std::unordered_set functionality.
\since 5.6 \since 5.6
Returns a \l{STL-style iterators}{STL-style} reverse iterator pointing to one past Returns a \l{STL-style iterators}{STL-style} reverse iterator pointing to one past
@ -431,11 +435,13 @@
*/ */
/*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::rend() const /*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::rend() const
\obsolete Deprecated in order to align with std::unordered_set functionality.
\since 5.6 \since 5.6
\overload \overload
*/ */
/*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::crend() const /*! \fn template <class T> QSet<T>::const_reverse_iterator QSet<T>::crend() const
\obsolete Deprecated in order to align with std::unordered_set functionality.
\since 5.6 \since 5.6
Returns a const \l{STL-style iterators}{STL-style} reverse iterator pointing to one Returns a const \l{STL-style iterators}{STL-style} reverse iterator pointing to one
@ -507,6 +513,7 @@
/*! \typedef QSet::reverse_iterator /*! \typedef QSet::reverse_iterator
\since 5.6 \since 5.6
\obsolete Deprecated in order to align with std::unordered_set functionality.
The QSet::reverse_iterator typedef provides an STL-style non-const The QSet::reverse_iterator typedef provides an STL-style non-const
reverse iterator for QSet. reverse iterator for QSet.
@ -523,6 +530,7 @@
/*! \typedef QSet::const_reverse_iterator /*! \typedef QSet::const_reverse_iterator
\since 5.6 \since 5.6
\obsolete Deprecated in order to align with std::unordered_set functionality.
The QSet::const_reverse_iterator typedef provides an STL-style const The QSet::const_reverse_iterator typedef provides an STL-style const
reverse iterator for QSet. reverse iterator for QSet.
@ -921,8 +929,20 @@
/*! /*!
\fn template <class T> QSet<T>::iterator &QSet<T>::iterator::operator--() \fn template <class T> QSet<T>::iterator &QSet<T>::iterator::operator--()
\obsolete This operator is deprecated in order to align with std::unordered_set functionality.
The prefix -- operator (\c{--it}) makes the preceding item
current and returns an iterator to the new current item.
Calling this function on QSet::begin() leads to undefined
results.
\sa operator++()
*/
/*!
\fn template <class T> QSet<T>::const_iterator &QSet<T>::const_iterator::operator--() \fn template <class T> QSet<T>::const_iterator &QSet<T>::const_iterator::operator--()
\obsolete \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
The prefix -- operator (\c{--it}) makes the preceding item The prefix -- 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.
@ -935,8 +955,17 @@
/*! /*!
\fn template <class T> QSet<T>::iterator QSet<T>::iterator::operator--(int) \fn template <class T> QSet<T>::iterator QSet<T>::iterator::operator--(int)
\obsolete This operator is deprecated in order to align with std::unordered_set functionality.
\overload
The postfix -- operator (\c{it--}) makes the preceding item
current and returns an iterator to the previously current item.
*/
/*!
\fn template <class T> QSet<T>::const_iterator QSet<T>::const_iterator::operator--(int) \fn template <class T> QSet<T>::const_iterator QSet<T>::const_iterator::operator--(int)
\obsolete \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
\overload \overload
@ -946,8 +975,19 @@
/*! /*!
\fn template <class T> QSet<T>::iterator QSet<T>::iterator::operator+(int j) const \fn template <class T> QSet<T>::iterator QSet<T>::iterator::operator+(int j) const
\obsolete This operator is deprecated in order to align with std::unordered_set functionality.
Returns an iterator to the item at \a j positions forward from
this iterator. (If \a j is negative, the iterator goes backward.)
This operation can be slow for large \a j values.
\sa operator-()
*/
/*!
\fn template <class T> QSet<T>::const_iterator QSet<T>::const_iterator::operator+(int j) const \fn template <class T> QSet<T>::const_iterator QSet<T>::const_iterator::operator+(int j) const
\obsolete \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
Returns an iterator to the item at \a j positions forward from Returns an iterator to the item at \a j positions forward from
this iterator. (If \a j is negative, the iterator goes backward.) this iterator. (If \a j is negative, the iterator goes backward.)
@ -959,8 +999,19 @@
/*! /*!
\fn template <class T> QSet<T>::iterator QSet<T>::iterator::operator-(int j) const \fn template <class T> QSet<T>::iterator QSet<T>::iterator::operator-(int j) const
\obsolete This operator is deprecated in order to align with std::unordered_set functionality.
Returns an iterator to the item at \a j positions backward from
this iterator. (If \a j is negative, the iterator goes forward.)
This operation can be slow for large \a j values.
\sa operator+()
*/
/*!
\fn template <class T> QSet<T>::const_iterator QSet<T>::const_iterator::operator-(int j) const \fn template <class T> QSet<T>::const_iterator QSet<T>::const_iterator::operator-(int j) const
\obsolete \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
Returns an iterator to the item at \a j positions backward from Returns an iterator to the item at \a j positions backward from
this iterator. (If \a j is negative, the iterator goes forward.) this iterator. (If \a j is negative, the iterator goes forward.)
@ -972,8 +1023,20 @@
/*! /*!
\fn template <class T> QSet<T>::iterator &QSet<T>::iterator::operator+=(int j) \fn template <class T> QSet<T>::iterator &QSet<T>::iterator::operator+=(int j)
\obsolete This operator is deprecated in order to align with std::unordered_set functionality.
Advances the iterator by \a j items. (If \a j is negative, the
iterator goes backward.)
This operation can be slow for large \a j values.
\sa operator-=(), operator+()
*/
/*!
\fn template <class T> QSet<T>::const_iterator &QSet<T>::const_iterator::operator+=(int j) \fn template <class T> QSet<T>::const_iterator &QSet<T>::const_iterator::operator+=(int j)
\obsolete \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
Advances the iterator by \a j items. (If \a j is negative, the Advances the iterator by \a j items. (If \a j is negative, the
iterator goes backward.) iterator goes backward.)
@ -985,8 +1048,19 @@
/*! /*!
\fn template <class T> QSet<T>::iterator &QSet<T>::iterator::operator-=(int j) \fn template <class T> QSet<T>::iterator &QSet<T>::iterator::operator-=(int j)
\obsolete This operator is deprecated in order to align with std::unordered_set functionality.
Makes the iterator go back by \a j items. (If \a j is negative,
the iterator goes forward.)
This operation can be slow for large \a j values.
\sa operator+=(), operator-()
*/
/*!
\fn template <class T> QSet<T>::const_iterator &QSet<T>::const_iterator::operator-=(int j) \fn template <class T> QSet<T>::const_iterator &QSet<T>::const_iterator::operator-=(int j)
\obsolete \obsolete This operator is deprecated in order to align with std::unordered_set functionality.
Makes the iterator go back by \a j items. (If \a j is negative, Makes the iterator go back by \a j items. (If \a j is negative,
the iterator goes forward.) the iterator goes forward.)