Doc: Add docs for rvalue references and move constructors

These members were introduced in 4.8, but left undocumented. Because we
consider undocumented API to be internal, the members are \since 5.2.

Change-Id: I52e2840a8cfaa7f59f410b3e2a06c0942ea06539
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com>

src/corelib/io/qdir.cpp

@@ -514,6 +514,14 @@ inline void QDirPrivate::initFileEngine()
     \sa QFileInfo, QFile, QFileDialog, QCoreApplication::applicationDirPath(), {Find Files Example}
 */
 
+/*!
+    \fn QDir &QDir::operator=(QDir &&other)
+
+    Move-assigns \a other to this QDir instance.
+
+    \since 5.2
+*/
+
 /*!
     \internal
 */

src/corelib/io/qfileinfo.cpp

@@ -293,6 +293,14 @@ QDateTime &QFileInfoPrivate::getFileTime(QAbstractFileEngine::FileTime request)
     \sa QDir, QFile
 */
 
+/*!
+    \fn QFileInfo &QFileInfo::operator=(QFileInfo &&other)
+
+    Move-assigns \a other to this QFileInfo instance.
+
+    \since 5.2
+*/
+
 /*!
     \internal
 */

src/corelib/io/qurl.cpp

@@ -363,6 +363,23 @@
     \sa QUrl::FormattingOptions
 */
 
+/*!
+    \fn QUrl::QUrl(QUrl &&other)
+
+    Move-constructs a QUrl instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
+/*!
+    \fn QUrl &QUrl::operator=(QUrl &&other)
+
+    Move-assigns \a other to this QUrl instance.
+
+    \since 5.2
+*/
+
 #include "qurl.h"
 #include "qurl_p.h"
 #include "qplatformdefs.h"

src/corelib/io/qurlquery.cpp

@@ -139,6 +139,14 @@ QT_BEGIN_NAMESPACE
   \sa QUrl
 */
 
+/*!
+    \fn QUrlQuery &QUrlQuery::operator=(QUrlQuery &&other)
+
+    Move-assigns \a other to this QUrlQuery instance.
+
+    \since 5.2
+*/
+
 typedef QList<QPair<QString, QString> > Map;
 
 class QUrlQueryPrivate : public QSharedData

src/corelib/itemmodels/qabstractitemmodel.cpp

@@ -107,6 +107,23 @@ void QPersistentModelIndexData::destroy(QPersistentModelIndexData *data)
   \sa {Model/View Programming}, QModelIndex, QAbstractItemModel
 */
 
+/*!
+    \fn QPersistentModelIndex::QPersistentModelIndex(QPersistentModelIndex &&other)
+
+    Move-constructs a QPersistentModelIndex instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
+/*!
+    \fn QPersistentModelIndex &QPersistentModelIndex::operator=(QPersistentModelIndex &&other)
+
+    Move-assigns \a other to this QPersistentModelIndex instance.
+
+    \since 5.2
+*/
+
 
 /*!
   \fn QPersistentModelIndex::QPersistentModelIndex()

src/corelib/kernel/qvariant.cpp

@@ -1104,6 +1104,23 @@ Q_CORE_EXPORT void QVariantPrivate::registerHandler(const int /* Modules::Names
     \omitvalue LastType
 */
 
+/*!
+    \fn QVariant::QVariant(QVariant &&other)
+
+    Move-constructs a QVariant instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
+/*!
+    \fn QVariant &QVariant::operator=(QVariant &&other)
+
+    Move-assigns \a other to this QVariant instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn QVariant::QVariant()
 

src/corelib/mimetypes/qmimetype.cpp

@@ -108,6 +108,14 @@ void QMimeTypePrivate::addGlobPattern(const QString &pattern)
     \sa QMimeDatabase
  */
 
+/*!
+    \fn QMimeType &QMimeType::operator=(QMimeType &&other)
+
+    Move-assigns \a other to this QMimeType instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn QMimeType::QMimeType();
     Constructs this QMimeType object initialized with default property values that indicate an invalid MIME type.

src/corelib/tools/qbitarray.cpp

@@ -110,6 +110,23 @@ QT_BEGIN_NAMESPACE
     \sa QByteArray, QVector
 */
 
+/*!
+    \fn QBitArray::QBitArray(QBitArray &&other)
+
+    Move-constructs a QBitArray instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
+/*!
+    \fn QBitArray &QBitArray::operator=(QBitArray &&other)
+
+    Move-assigns \a other to this QBitArray instance.
+
+    \since 5.2
+*/
+
 /*! \fn QBitArray::QBitArray()
 
     Constructs an empty bit array.

src/corelib/tools/qbytearray.cpp

@@ -910,6 +910,15 @@ static inline char qToLower(char c)
     \sa operator=()
 */
 
+/*!
+    \fn QByteArray::QByteArray(QByteArray &&other)
+
+    Move-constructs a QByteArray instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
 /*! \fn QByteArray::QByteArray(QByteArrayDataPtr dd)
 
     \internal
@@ -965,6 +974,14 @@ QByteArray &QByteArray::operator=(const char *str)
     return *this;
 }
 
+/*!
+    \fn QByteArray &QByteArray::operator=(QByteArray &&other)
+
+    Move-assigns \a other to this QByteArray instance.
+
+    \since 5.2
+*/
+
 /*! \fn void QByteArray::swap(QByteArray &other)
     \since 4.8
 

src/corelib/tools/qcommandlineoption.cpp

@@ -87,6 +87,14 @@ public:
     \sa QCommandLineParser
 */
 
+/*!
+    \fn QCommandLineOption &QCommandLineOption::operator=(QCommandLineOption &&other)
+
+    Move-assigns \a other to this QCommandLineOption instance.
+
+    \since 5.2
+*/
+
 /*!
     Constructs a command line option object with the given arguments.
 

src/corelib/tools/qcontiguouscache.cpp

@@ -202,6 +202,14 @@ MyRecord record(int row) const
     Assigns \a other to this cache and returns a reference to this cache.
 */
 
+/*!
+    \fn QContiguousCache<T> &QContiguousCache::operator=(QContiguousCache<T> &&other)
+
+    Move-assigns \a other to this QContiguousCache instance.
+
+    \since 5.2
+*/
+
 /*! \fn void QContiguousCache::swap(QContiguousCache<T> &other)
     \since 4.8
 

src/corelib/tools/qeasingcurve.cpp

@@ -1065,6 +1065,15 @@ static QEasingCurveFunction *curveToFunctionObject(QEasingCurve::Type type)
     return curveFunc;
 }
 
+/*!
+    \fn QEasingCurve::QEasingCurve(QEasingCurve &&other)
+
+    Move-constructs a QEasingCurve instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
 /*!
     Constructs an easing curve of the given \a type.
  */
@@ -1097,6 +1106,14 @@ QEasingCurve::~QEasingCurve()
     Copy \a other.
  */
 
+/*!
+    \fn QEasingCurve &QEasingCurve::operator=(QEasingCurve &&other)
+
+    Move-assigns \a other to this QEasingCurve instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn void QEasingCurve::swap(QEasingCurve &other)
     \since 5.0

src/corelib/tools/qhash.cpp

@@ -941,6 +941,15 @@ void QHashData::checkSanity()
     \sa clear()
 */
 
+/*!
+    \fn QHash::QHash(QHash<Key, T> &&other)
+
+    Move-constructs a QHash instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
 /*! \fn QHash::QHash(std::initializer_list<std::pair<Key,T> > list)
     \since 5.1
 
@@ -974,6 +983,14 @@ void QHashData::checkSanity()
     Assigns \a other to this hash and returns a reference to this hash.
 */
 
+/*!
+    \fn QHash<Key, T> &QHash::operator=(QHash<Key, T> &&other)
+
+    Move-assigns \a other to this QHash instance.
+
+    \since 5.2
+*/
+
 /*! \fn void QHash::swap(QHash<Key, T> &other)
     \since 4.8
 

src/corelib/tools/qlinkedlist.cpp

@@ -125,6 +125,15 @@ const QLinkedListData QLinkedListData::shared_null = {
     Constructs an empty list.
 */
 
+/*!
+    \fn QLinkedList::QLinkedList(QLinkedList<T> &&other)
+
+    Move-constructs a QLinkedList instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
 /*! \fn QLinkedList::QLinkedList(const QLinkedList<T> &other)
 
     Constructs a copy of \a other.
@@ -740,6 +749,14 @@ const QLinkedListData QLinkedListData::shared_null = {
     Assigns \a other to this iterator.
 */
 
+/*!
+    \fn QLinkedList<T> &QLinkedList::operator=(QLinkedList<T> &&other)
+
+    Move-assigns \a other to this QLinkedList instance.
+
+    \since 5.2
+*/
+
 /*! \fn T &QLinkedList::iterator::operator*() const
 
     Returns a modifiable reference to the current item.

src/corelib/tools/qlist.cpp

@@ -479,6 +479,15 @@ void **QListData::erase(void **xi)
     \sa QListIterator, QMutableListIterator, QLinkedList, QVector
 */
 
+/*!
+    \fn QList::QList(QList<T> &&other)
+
+    Move-constructs a QList instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
 /*!
     \fn QList<T> QList<T>::mid(int pos, int length) const
 
@@ -527,6 +536,14 @@ void **QListData::erase(void **xi)
     list.
 */
 
+/*!
+    \fn QList &QList::operator=(QList<T> &&other)
+
+    Move-assigns \a other to this QList instance.
+
+    \since 5.2
+*/
+
 /*! \fn void QList::swap(QList<T> &other)
     \since 4.8
 

src/corelib/tools/qmap.cpp

@@ -516,6 +516,15 @@ void QMapDataBase::freeData(QMapDataBase *d)
     \sa clear()
 */
 
+/*!
+    \fn QMap::QMap(QMap<Key, T> &&other)
+
+    Move-constructs a QMap instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
 /*! \fn QMap::QMap(const QMap<Key, T> &other)
 
     Constructs a copy of \a other.
@@ -567,6 +576,14 @@ void QMapDataBase::freeData(QMapDataBase *d)
     Assigns \a other to this map and returns a reference to this map.
 */
 
+/*!
+    \fn QMap<Key, T> &QMap::operator=(QMap<Key, T> &&other)
+
+    Move-assigns \a other to this QMap instance.
+
+    \since 5.2
+*/
+
 /*! \fn void QMap::swap(QMap<Key, T> &other)
     \since 4.8
 

src/corelib/tools/qregexp.cpp

@@ -4012,6 +4012,14 @@ QRegExp &QRegExp::operator=(const QRegExp &rx)
     return *this;
 }
 
+/*!
+    \fn QRegExp &QRegExp::operator=(QRegExp &&other)
+
+    Move-assigns \a other to this QRegExp instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn void QRegExp::swap(QRegExp &other)
     \since 4.8

src/corelib/tools/qshareddata.cpp

@@ -306,6 +306,14 @@ QT_BEGIN_NAMESPACE
   data pointer in \a other.
  */
 
+/*!
+    \fn QSharedDataPointer<T> &QSharedDataPointer::operator=(QSharedDataPointer<T> &&other)
+
+    Move-assigns \a other to this QSharedDataPointer instance.
+
+    \since 5.2
+*/
+
 /*! \fn bool QSharedDataPointer::operator==(const QSharedDataPointer<T>& other) const
     Returns true if \a other and \e this have the same \e{d pointer}.
     This function does \e not call detach().
@@ -320,6 +328,15 @@ QT_BEGIN_NAMESPACE
     Constructs a QSharedDataPointer initialized with a null \e{d pointer}.
 */
 
+/*!
+    \fn QSharedDataPointer::QSharedDataPointer(QSharedDataPointer &&o)
+
+    Move-constructs a QSharedDataPointer instance, making it point at the same
+    object that \a o was pointing to.
+
+    \since 5.2
+*/
+
 /*! \fn QSharedDataPointer::~QSharedDataPointer()
     Decrements the reference count of the shared data object.
     If the reference count becomes 0, the shared data object
@@ -465,6 +482,14 @@ QT_BEGIN_NAMESPACE
     Returns true if \a other and \e this have the same \e{d pointer}.
 */
 
+/*!
+    \fn QExplicitlySharedDataPointer<T> &QExplicitlySharedDataPointer::operator=(QExplicitlySharedDataPointer<T> &&other)
+
+    Move-assigns \a other to this QExplicitlySharedDataPointer instance.
+
+    \since 5.2
+*/
+
 /*! \fn bool QExplicitlySharedDataPointer::operator==(const T* ptr) const
     Returns true if the \e{d pointer} of \e this is \a ptr.
  */
@@ -489,6 +514,15 @@ QT_BEGIN_NAMESPACE
     is deleted. \e This is then destroyed.
 */
 
+/*!
+    \fn QExplicitlySharedDataPointer::QExplicitlySharedDataPointer(QExplicitlySharedDataPointer &&o)
+
+    Move-constructs a QExplicitlySharedDataPointer instance, making it point at the same
+    object that \a o was pointing to.
+
+    \since 5.2
+*/
+
 /*! \fn QExplicitlySharedDataPointer::QExplicitlySharedDataPointer(T* sharedData)
     Constructs a QExplicitlySharedDataPointer with \e{d pointer}
     set to \a sharedData and increments \a{sharedData}'s reference

src/corelib/tools/qstring.cpp

@@ -929,6 +929,15 @@ const QString::Null QString::null = { };
     \sa isEmpty()
 */
 
+/*!
+    \fn QString::QString(QString &&other)
+
+    Move-constructs a QString instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
 /*! \fn QString::QString(const char *str)
 
     Constructs a string initialized with the 8-bit string \a str. The
@@ -1349,6 +1358,13 @@ QString &QString::operator=(const QString &other)
     return *this;
 }
 
+/*!
+    \fn QString &QString::operator=(QString &&other)
+
+    Move-assigns \a other to this QString instance.
+
+    \since 5.2
+*/
 
 /*! \fn QString &QString::operator=(QLatin1String str)
 

src/corelib/tools/qtimezone.cpp

@@ -422,6 +422,15 @@ QTimeZone &QTimeZone::operator=(const QTimeZone &other)
     return *this;
 }
 
+/*!
+    \fn QTimeZone &QTimeZone::operator=(QTimeZone &&other)
+
+    Move-assigns \a other to this QTimeZone instance, transferring the
+    ownership of the managed pointer to this instance.
+
+    \since 5.2
+*/
+
 /*!
     Returns true if this time zone is equal to the \a other time zone.
 */

src/corelib/tools/qvector.cpp

@@ -195,6 +195,15 @@
     \sa resize()
 */
 
+/*!
+    \fn QVector::QVector(QVector<T> &&other)
+
+    Move-constructs a QVector instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
 /*! \fn QVector::QVector(int size)
 
     Constructs a vector with an initial size of \a size elements.
@@ -246,6 +255,14 @@
     vector.
 */
 
+/*!
+    \fn QVector<T> &QVector::operator=(QVector<T> &&other)
+
+    Move-assigns \a other to this QVector instance.
+
+    \since 5.2
+*/
+
 /*! \fn void QVector::swap(QVector<T> &other)
     \since 4.8
 

src/gui/image/qicon.cpp

@@ -643,6 +643,14 @@ QIcon &QIcon::operator=(const QIcon &other)
     return *this;
 }
 
+/*!
+    \fn QIcon &QIcon::operator=(QIcon &&other)
+
+    Move-assigns \a other to this QIcon instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn void QIcon::swap(QIcon &other)
     \since 4.8

src/gui/image/qimage.cpp

@@ -601,6 +601,23 @@ bool QImageData::checkForAlphaPixels() const
         {Image Viewer Example}, {Scribble Example}, {Pixelator Example}
 */
 
+/*!
+    \fn QImage::QImage(QImage &&other)
+
+    Move-constructs a QImage instance, making it point at the same
+    object that \a other was pointing to.
+
+    \since 5.2
+*/
+
+/*!
+    \fn QImage &operator=(QImage &&other)
+
+    Move-assigns \a other to this QImage instance.
+
+    \since 5.2
+*/
+
 /*!
     \typedef QImageCleanupFunction
     \relates QImage

src/gui/image/qpicture.cpp

@@ -109,6 +109,14 @@ void qt_format_text(const QFont &fnt, const QRectF &_r,
     \sa QMovie
 */
 
+/*!
+    \fn QPicture &QPicture::operator=(QPicture &&other)
+
+    Move-assigns \a other to this QPicture instance.
+
+    \since 5.2
+*/
+
 const char  *qt_mfhdr_tag = "QPIC"; // header tag
 static const quint16 mfhdr_maj = 11; // major version #
 static const quint16 mfhdr_min = 0; // minor version #

src/gui/image/qpixmap.cpp

@@ -391,6 +391,14 @@ QPixmap &QPixmap::operator=(const QPixmap &pixmap)
     return *this;
 }
 
+/*!
+    \fn QPixmap &QPixmap::operator=(QPixmap &&other)
+
+    Move-assigns \a other to this QPixmap instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn void QPixmap::swap(QPixmap &other)
     \since 4.8

src/gui/kernel/qcursor.cpp

@@ -153,6 +153,14 @@ QT_BEGIN_NAMESPACE
     \sa QWidget, {fowler}{GUI Design Handbook: Cursors}
 */
 
+/*!
+    \fn QCursor &QCursor::operator=(QCursor &&other)
+
+    Move-assigns \a other to this QCursor instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn QPoint QCursor::pos(const QScreen *screen)
 

src/gui/kernel/qkeysequence.cpp

@@ -732,6 +732,14 @@ static const struct {
     \value FullScreen       Toggle the window state to/from full screen.
 */
 
+/*!
+    \fn QKeySequence &QKeySequence::operator=(QKeySequence &&other)
+
+    Move-assigns \a other to this QKeySequence instance.
+
+    \since 5.2
+*/
+
 /*!
     \since 4.2
 

src/gui/kernel/qpalette.cpp

@@ -89,6 +89,14 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button)
                       whiteBrush, buttonBrush, buttonBrush);
 }
 
+/*!
+    \fn QPalette &QPalette::operator=(QPalette &&other)
+
+    Move-assigns \a other to this QPalette instance.
+
+    \since 5.2
+*/
+
 /*!
    \fn const QColor &QPalette::color(ColorRole role) const
 

src/gui/painting/qbrush.cpp

@@ -631,6 +631,13 @@ QBrush &QBrush::operator=(const QBrush &b)
     return *this;
 }
 
+/*!
+    \fn QBrush &QBrush::operator=(QBrush &&other)
+
+    Move-assigns \a other to this QBrush instance.
+
+    \since 5.2
+*/
 
 /*!
     \fn void QBrush::swap(QBrush &other)

src/gui/painting/qpainterpath.cpp

@@ -607,6 +607,14 @@ QPainterPath &QPainterPath::operator=(const QPainterPath &other)
     return *this;
 }
 
+/*!
+    \fn QPainterPath &QPainterPath::operator=(QPainterPath &&other)
+
+    Move-assigns \a other to this QPainterPath instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn void QPainterPath::swap(QPainterPath &other)
     \since 4.8

src/gui/painting/qpen.cpp

@@ -377,6 +377,14 @@ QPen &QPen::operator=(const QPen &p)
     return *this;
 }
 
+/*!
+    \fn QPen &QPen::operator=(QPen &&other)
+
+    Move-assigns \a other to this QPen instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn void QPen::swap(QPen &other)
     \since 4.8

src/gui/painting/qregion.cpp

@@ -360,6 +360,14 @@ void QRegion::exec(const QByteArray &buffer, int ver, QDataStream::ByteOrder byt
     Assigns \a r to this region and returns a reference to the region.
 */
 
+/*!
+    \fn QRegion &QRegion::operator=(QRegion &&other)
+
+    Move-assigns \a other to this QRegion instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn void QRegion::swap(QRegion &other)
     \since 4.8

src/gui/text/qfont.cpp

@@ -536,6 +536,14 @@ QFontEngineData::~QFontEngineData()
     \sa Weight
 */
 
+/*!
+    \fn QFont &QFont::operator=(QFont &&other)
+
+    Move-assigns \a other to this QFont instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn QString QFont::rawName() const
 

src/gui/text/qfontmetrics.cpp

@@ -212,6 +212,14 @@ QFontMetrics &QFontMetrics::operator=(const QFontMetrics &fm)
     return *this;
 }
 
+/*!
+    \fn QFontMetrics &QFontMetrics::operator=(QFontMetrics &&other)
+
+    Move-assigns \a other to this QFontMetrics instance.
+
+    \since 5.2
+*/
+
 /*!
     \fn void QFontMetrics::swap(QFontMetrics &other)
     \since 5.0