Doc: fix a bunch of qdoc warnings from wrong prototypes

* name method parameters consistently with their declaration
* don't document parameters that are not there

Pick-to: 6.2
Change-Id: I06ae9fdca357ed29eb7a72802f149eb4914181f4
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Volker Hilsheimer 2021-09-03 15:36:50 +02:00
parent 823c4951b2
commit 62fc486a77
4 changed files with 8 additions and 12 deletions

View File

@ -383,10 +383,10 @@ static QUuid createFromName(const QUuid &ns, const QByteArray &baseData, QCrypto
*/ */
/*! /*!
\fn static QUuid::fromString(QAnyStringView text) \fn static QUuid::fromString(QAnyStringView string)
\since 5.10 \since 5.10
Creates a QUuid object from the string \a text, which must be Creates a QUuid object from the string \a string, which must be
formatted as five hex fields separated by '-', e.g., formatted as five hex fields separated by '-', e.g.,
"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where each 'x' is a hex "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where each 'x' is a hex
digit. The curly braces shown here are optional, but it is normal to digit. The curly braces shown here are optional, but it is normal to

View File

@ -4043,8 +4043,7 @@ qsizetype QString::lastIndexOf(const QString &str, qsizetype from, Qt::CaseSensi
\overload lastIndexOf() \overload lastIndexOf()
Returns the index position of the last occurrence of the string \a Returns the index position of the last occurrence of the string \a
str in this string, searching backward from index position \a str in this string. Returns -1 if \a str is not found.
from. Returns -1 if \a str is not found.
If \a cs is Qt::CaseSensitive (default), the search is case If \a cs is Qt::CaseSensitive (default), the search is case
sensitive; otherwise the search is case insensitive. sensitive; otherwise the search is case insensitive.
@ -4095,8 +4094,7 @@ qsizetype QString::lastIndexOf(QLatin1String str, qsizetype from, Qt::CaseSensit
\overload lastIndexOf() \overload lastIndexOf()
Returns the index position of the last occurrence of the string \a Returns the index position of the last occurrence of the string \a
str in this string, searching backward from index position \a str in this string. Returns -1 if \a str is not found.
from. Returns -1 if \a str is not found.
If \a cs is Qt::CaseSensitive (default), the search is case If \a cs is Qt::CaseSensitive (default), the search is case
sensitive; otherwise the search is case insensitive. sensitive; otherwise the search is case insensitive.
@ -4149,8 +4147,7 @@ qsizetype QString::lastIndexOf(QChar ch, qsizetype from, Qt::CaseSensitivity cs)
\overload lastIndexOf() \overload lastIndexOf()
Returns the index position of the last occurrence of the string view \a Returns the index position of the last occurrence of the string view \a
str in this string, searching backward from index position \a str in this string. Returns -1 if \a str is not found.
from. Returns -1 if \a str is not found.
If \a cs is Qt::CaseSensitive (default), the search is case If \a cs is Qt::CaseSensitive (default), the search is case
sensitive; otherwise the search is case insensitive. sensitive; otherwise the search is case insensitive.

View File

@ -965,8 +965,8 @@ QT_BEGIN_NAMESPACE
\since 6.2 \since 6.2
Returns the index position of the last match of the regular Returns the index position of the last match of the regular
expression \a re in the string view, which starts before the index expression \a re in the string view. Returns -1 if \a re didn't match
position \a from. Returns -1 if \a re didn't match anywhere. anywhere.
If the match is successful and \a rmatch is not \nullptr, it also If the match is successful and \a rmatch is not \nullptr, it also
writes the results of the match into the QRegularExpressionMatch object writes the results of the match into the QRegularExpressionMatch object

View File

@ -450,8 +450,7 @@ void QCryptographicHash::addData(const char *data, qsizetype length)
#endif #endif
/*! /*!
Adds the first \a length chars of \a data to the cryptographic Adds the characters in \a bytes to the cryptographic hash.
hash.
\note In Qt versions prior to 6.3, this function took QByteArray, \note In Qt versions prior to 6.3, this function took QByteArray,
not QByteArrayView. not QByteArrayView.