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

qdoc: Fix \fn commands for QCborxxx member functions

Browse Source 
Severa qdoc function comments had incorrect signatures. This update corrects
them to match the declarations in the header file. A \keyword command was also
added for linking to the generic algorithms header file page.

Change-Id: I997f7f2c7e4d0c3fcd269ee2c89a2836fecd4927
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
This commit is contained in:
Martin Smith 2018-08-06 13:27:18 +02:00
parent ca5d53abc2
commit ed7f86cb07
3 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/corelib/serialization/qcborarray.cpp
View File

@ -790,7 +790,7 @@ void QCborArray::detach(qsizetype reserved)
*/
/*!
\fn QCborValueRef QCborArray::Iterator::operator[](qsizetype j) const
\fn QCborValueRef QCborArray::Iterator::operator[](qsizetype j)
Returns a modifiable reference to the item at a position \a j steps forward
from the item pointed to by this iterator.
@ -1036,7 +1036,7 @@ void QCborArray::detach(qsizetype reserved)
*/
/*!
\fn QCborValue QCborArray::ConstIterator::operator[](qsizetype j) const
\fn const QCborValueRef QCborArray::ConstIterator::operator[](qsizetype j)
Returns the item at a position \a j steps forward from the item pointed to
by this iterator.
@ -1057,9 +1057,10 @@ void QCborArray::detach(qsizetype reserved)
*/
/*!
\fn bool QCborArray::ConstIterator::operator!=(const ConstIterator &other) const
\fn bool QCborArray::ConstIterator::operator!=(const Iterator &o) const
\fn bool QCborArray::ConstIterator::operator!=(const ConstIterator &o) const
Returns \c true if \a other points to a different entry in the array than
Returns \c true if \a o points to a different entry in the array than
this iterator; otherwise returns \c false.
\sa operator==()

16
src/corelib/serialization/qcbormap.cpp
View File

@ -344,7 +344,7 @@ QVector<QCborValue> QCborMap::keys() const
*/
/*!
\fn QCborValue QCborArray::take(qint64 key)
\fn QCborValue QCborMap::take(qint64 key)
Removes the key \a key and the corresponding value from the map and returns
the value, if it is found. If the map contains no such key, this function does nothing.
@ -376,7 +376,7 @@ QVector<QCborValue> QCborMap::keys() const
*/
/*!
\fn bool QCborMap::contains(qint64 key)
\fn bool QCborMap::contains(qint64 key) const
Returns true if this map contains a key-value pair identified by key \a
key. CBOR recommends using integer keys, since they occupy less space and
@ -469,7 +469,7 @@ QCborValueRef QCborMap::operator[](qint64 key)
*/
/*!
\fn QCborValue QCborArray::take(QLatin1String key)
\fn QCborValue QCborMap::take(QLatin1String key)
Removes the key \a key and the corresponding value from the map and returns
the value, if it is found. If the map contains no such key, this function does nothing.
@ -502,7 +502,7 @@ QCborValueRef QCborMap::operator[](qint64 key)
*/
/*!
\fn bool QCborMap::contains(QLatin1String key)
\fn bool QCborMap::contains(QLatin1String key) const
\overload
Returns true if this map contains a key-value pair identified by key \a
@ -596,7 +596,7 @@ QCborValueRef QCborMap::operator[](QLatin1String key)
*/
/*!
\fn QCborValue QCborArray::take(const QString &key)
\fn QCborValue QCborMap::take(const QString &key)
Removes the key \a key and the corresponding value from the map and returns
the value, if it is found. If the map contains no such key, this function does nothing.
@ -630,7 +630,7 @@ QCborValueRef QCborMap::operator[](QLatin1String key)
*/
/*!
\fn bool QCborMap::contains(const QString &key)
\fn bool QCborMap::contains(const QString &key) const
\overload
Returns true if this map contains a key-value pair identified by key \a
@ -723,7 +723,7 @@ QCborValueRef QCborMap::operator[](const QString & key)
*/
/*!
\fn QCborValue QCborArray::take(const QCborValue &key)
\fn QCborValue QCborMap::take(const QCborValue &key)
Removes the key \a key and the corresponding value from the map and returns
the value, if it is found. If the map contains no such key, this function does nothing.
@ -756,7 +756,7 @@ QCborValueRef QCborMap::operator[](const QString & key)
*/
/*!
\fn bool QCborMap::contains(const QCborValue &key)
\fn bool QCborMap::contains(const QCborValue &key) const
Returns true if this map contains a key-value pair identified by key \a
key.

1
src/corelib/tools/qalgorithms.qdoc
View File

@ -29,6 +29,7 @@
\headerfile <QtAlgorithms>
\title Generic Algorithms
\ingroup funclists
\keyword generic algorithms
\brief The <QtAlgorithms> header includes the generic, template-based algorithms.