Doc: Prepare for building modular QtCore docs.

This change fixes most qdoc errors in QtCore. There are about 900 left.
The main thing this change does is moving documentation from qtcore from
/doc/src to /src/corelib/doc.
Other issues resolved are mis-use of qdoc commands.

Change-Id: I002d01edfb13575e8bf27ce91596a577a92562d1
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
Reviewed-by: Jason McDonald <jason.mcdonald@nokia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>

3 files changed, 31 insertions, 42 deletions

diff --git a/src/corelib/json/qjsonarray.cpp b/src/corelib/json/qjsonarray.cpp
index 0884f10354..e1ed53a840 100644
--- a/src/corelib/json/qjsonarray.cpp
+++ b/src/corelib/json/qjsonarray.cpp
@@ -500,13 +500,13 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
     \sa constBegin(), end()
 */
 
-/*! \fn void QJsonArray::push_back(const T &value)
+/*! \fn void QJsonArray::push_back(const QJsonValue &value)
 
     This function is provided for STL compatibility. It is equivalent
     to \l{QJsonArray::append()}{append(\a value)}.
 */
 
-/*! \fn void QJsonArray::push_front(const T &value)
+/*! \fn void QJsonArray::push_front(const QJsonValue &value)
 
     This function is provided for STL compatibility. It is equivalent
     to \l{QJsonArray::prepend()}{prepend(\a value)}.
@@ -589,12 +589,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
     on an uninitialized iterator. Use operator=() to assign a value
     to it before using it.
 
-    \sa QJsonArray::begin() QJsonArray::end()
-*/
-
-/*! \fn QJsonArray::iterator::iterator(const iterator &other)
-
-    Constructs a copy of \a other.
+    \sa QJsonArray::begin(), QJsonArray::end()
 */
 
 /*! \fn QJsonValueRef QJsonArray::iterator::operator*() const
@@ -791,7 +786,7 @@ bool QJsonArray::operator!=(const QJsonArray &other) const
     on an uninitialized iterator. Use operator=() to assign a value
     to it before using it.
 
-    \sa QJsonArray::constBegin() QJsonArray::constEnd()
+    \sa QJsonArray::constBegin(), QJsonArray::constEnd()
 */
 
 /*! \typedef QJsonArray::const_iterator::iterator_category
diff --git a/src/corelib/json/qjsondocument.cpp b/src/corelib/json/qjsondocument.cpp
index be241bc3fc..ae59847dc6 100644
--- a/src/corelib/json/qjsondocument.cpp
+++ b/src/corelib/json/qjsondocument.cpp
@@ -176,7 +176,7 @@ QJsonDocument &QJsonDocument::operator =(const QJsonDocument &other)
 
  Returns a QJsonDocument representing the data.
 
- \sa rawData fromBinaryData isNull DataValidation
+ \sa rawData, fromBinaryData, isNull, DataValidation
  */
 QJsonDocument QJsonDocument::fromRawData(const char *data, int size, DataValidation validation)
 {
@@ -220,7 +220,7 @@ const char *QJsonDocument::rawData(int *size) const
  By default the data is validated. If the \a data is not valid, the method returns
  a null document.
 
- \sa toBinaryData fromRawData isNull DataValidation
+ \sa toBinaryData, fromRawData, isNull, DataValidation
  */
 QJsonDocument QJsonDocument::fromBinaryData(const QByteArray &data, DataValidation validation)
 {
@@ -361,7 +361,7 @@ QByteArray QJsonDocument::toBinaryData() const
 /*!
     Returns true if the document contains an array.
 
-    \sa array() isObject()
+    \sa array(), isObject()
  */
 bool QJsonDocument::isArray() const
 {
@@ -375,7 +375,7 @@ bool QJsonDocument::isArray() const
 /*!
     Returns true if the document contains an object.
 
-    \sa object() isArray()
+    \sa object(), isArray()
  */
 bool QJsonDocument::isObject() const
 {
@@ -392,7 +392,7 @@ bool QJsonDocument::isObject() const
     Returns an empty object if the document contains an
     array.
 
-    \sa isObject array setObject
+    \sa isObject, array, setObject
  */
 QJsonObject QJsonDocument::object() const
 {
@@ -410,7 +410,7 @@ QJsonObject QJsonDocument::object() const
     Returns an empty array if the document contains an
     object.
 
-    \sa isArray object setArray
+    \sa isArray, object, setArray
  */
 QJsonArray QJsonDocument::array() const
 {
@@ -425,7 +425,7 @@ QJsonArray QJsonDocument::array() const
 /*!
     Sets \a object as the main object of this document.
 
-    \sa setArray object
+    \sa setArray, object
  */
 void QJsonDocument::setObject(const QJsonObject &object)
 {
@@ -452,7 +452,7 @@ void QJsonDocument::setObject(const QJsonObject &object)
 /*!
     Sets \a array as the main object of this document.
 
-    \sa setObject array
+    \sa setObject, array
  */
 void QJsonDocument::setArray(const QJsonArray &array)
 {
diff --git a/src/corelib/json/qjsonobject.cpp b/src/corelib/json/qjsonobject.cpp
index e880078195..5439855b90 100644
--- a/src/corelib/json/qjsonobject.cpp
+++ b/src/corelib/json/qjsonobject.cpp
@@ -74,7 +74,7 @@ QT_BEGIN_NAMESPACE
 /*!
     Constructs an empty JSON object
 
-    \sa isEmpty
+    \sa isEmpty()
  */
 QJsonObject::QJsonObject()
     : d(0), o(0)
@@ -139,7 +139,7 @@ QJsonObject &QJsonObject::operator =(const QJsonObject &other)
     The keys in \a map will be used as the keys in the JSON object,
     and the QVariant values will be converted to JSON values.
 
-    \sa toVariantMap, QJsonValue::fromVariant
+    \sa toVariantMap(), QJsonValue::fromVariant()
  */
 QJsonObject QJsonObject::fromVariantMap(const QVariantMap &map)
 {
@@ -200,7 +200,7 @@ int QJsonObject::size() const
 /*!
     Returns \c true if the object is empty. This is the same as size() == 0.
 
-    \sa size
+    \sa size()
  */
 bool QJsonObject::isEmpty() const
 {
@@ -215,7 +215,7 @@ bool QJsonObject::isEmpty() const
 
     The returned QJsonValue is \c Undefined, if the key does not exist.
 
-    \sa setValue, QJsonValue, QJsonValue::isUndefined
+    \sa QJsonValue, QJsonValue::isUndefined()
  */
 QJsonValue QJsonObject::value(const QString &key) const
 {
@@ -236,7 +236,7 @@ QJsonValue QJsonObject::value(const QString &key) const
 
     The returned QJsonValue is \c Undefined, if the key does not exist.
 
-    \sa value, setValue, QJsonValue, QJsonValue::isUndefined
+    \sa value(), QJsonValue, QJsonValue::isUndefined()
  */
 QJsonValue QJsonObject::operator [](const QString &key) const
 {
@@ -252,7 +252,7 @@ QJsonValue QJsonObject::operator [](const QString &key) const
     the assignment will apply to the character in the QJsonArray of QJsonObject
     from which you got the reference.
 
-    \sa setValue, value
+    \sa value()
  */
 QJsonValueRef QJsonObject::operator [](const QString &key)
 {
@@ -277,7 +277,7 @@ QJsonValueRef QJsonObject::operator [](const QString &key)
     If the value is QJsonValue::Undefined, it will cause the key to get removed
     from the object. The returned iterator will then point to end()
 
-    \sa remove, take, QJsonObject::iterator, end
+    \sa remove(), take(), QJsonObject::iterator, end()
  */
 QJsonObject::iterator QJsonObject::insert(const QString &key, const QJsonValue &value)
 {
@@ -320,7 +320,7 @@ QJsonObject::iterator QJsonObject::insert(const QString &key, const QJsonValue &
 /*!
     Removes \a key from the object.
 
-    \sa insert, take
+    \sa insert(), take()
  */
 void QJsonObject::remove(const QString &key)
 {
@@ -346,7 +346,7 @@ void QJsonObject::remove(const QString &key)
     If \a key was not contained in the object, the returned QJsonValue
     is Undefined.
 
-    \sa insert, remove, QJsonValue
+    \sa insert(), remove(), QJsonValue
  */
 QJsonValue QJsonObject::take(const QString &key)
 {
@@ -370,7 +370,7 @@ QJsonValue QJsonObject::take(const QString &key)
 /*!
     Returns \c true if the object contains key \a key.
 
-    \sa insert, remove, take
+    \sa insert(), remove(), take()
  */
 bool QJsonObject::contains(const QString &key) const
 {
@@ -455,7 +455,7 @@ QJsonObject::iterator QJsonObject::find(const QString &key)
     return iterator(this, index);
 }
 
-/*! \fn QJsonObject::const_iterator QJsonObject::find(const Key &key) const
+/*! \fn QJsonObject::const_iterator QJsonObject::find(const QString &key) const
 
     \overload
 */
@@ -541,6 +541,10 @@ QJsonObject::const_iterator QJsonObject::constFind(const QString &key) const
 */
 
 /*! \class QJsonObject::iterator
+    \ingroup json
+    \reentrant
+    \since 5.0
+
     \brief The QJsonObject::iterator class provides an STL-style non-const iterator for QJsonObject.
 
     QJsonObject::iterator allows you to iterate over a QJsonObject
@@ -591,7 +595,7 @@ QJsonObject::const_iterator QJsonObject::constFind(const QString &key) const
     called on an uninitialized iterator. Use operator=() to assign a
     value to it before using it.
 
-    \sa QJsonObject::begin() QJsonObject::end()
+    \sa QJsonObject::begin(), QJsonObject::end()
 */
 
 /*! \fn QString QJsonObject::iterator::key() const
@@ -729,7 +733,8 @@ QJsonObject::const_iterator QJsonObject::constFind(const QString &key) const
     \sa operator+=(), operator-()
 */
 
-/*! \class QJsonObject::const_iterator
+/*!
+    \class QJsonObject::const_iterator
     \brief The QJsonObject::const_iterator class provides an STL-style const iterator for QJsonObject.
 
     QJsonObject::const_iterator allows you to iterate over a QJsonObject.
@@ -780,7 +785,7 @@ QJsonObject::const_iterator QJsonObject::constFind(const QString &key) const
     called on an uninitialized iterator. Use operator=() to assign a
     value to it before using it.
 
-    \sa QJsonObject::constBegin() QJsonObject::constEnd()
+    \sa QJsonObject::constBegin(), QJsonObject::constEnd()
 */
 
 /*! \fn QJsonObject::const_iterator::const_iterator(const iterator &other)
@@ -987,17 +992,6 @@ void QJsonObject::setValueAt(int i, const QJsonValue &val)
     Qt-style synonym for QJsonObject::const_iterator.
 */
 
-
-/*! \class QJsonObject::iterator
-    \ingroup json
-    \reentrant
-    \since 5.0
-
-    \brief The QJsonDocument::iterator class provides a way to iterate over q QJsonObject
-
-
- */
-
 #ifndef QT_NO_DEBUG_STREAM
 QDebug operator<<(QDebug dbg, const QJsonObject &o)
 {