1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix some qdoc warnings

Browse Source 
src/corelib/serialization/qjsonvalue.cpp:174: (qdoc) warning: No such parameter 'n' in QJsonValue::QJsonValue()
...
examples/widgets/doc/src/icons.qdoc:584: (qdoc) warning: Command '\snippet (//! [24])' failed at end of file 'widgets/icons/mainwindow.cpp'
src/corelib/text/qbytearray.cpp:5177: (qdoc) warning: clang found diagnostics parsing \fn QByteArray::FromBase64Result::operator QByteArray() const
    error: out-of-line definition of 'operator QByteArray' does not match any declaration in 'QByteArray::FromBase64Result'
src/corelib/serialization/qjsonarray.cpp:178: (qdoc) warning: Overrides a previous doc
src/corelib/serialization/qjsonarray.cpp:140: (qdoc) warning: (The previous doc is here)
src/corelib/serialization/qjsonobject.cpp:1016: (qdoc) warning: clang found diagnostics parsing \fn QJsonValueRef QJsonObject::iterator::operator[](int j) const
    error: out-of-line definition of 'operator[]' does not match any declaration in 'QJsonObject::iterator'
src/corelib/serialization/qjsonobject.cpp:1267: (qdoc) warning: clang found diagnostics parsing \fn QJsonValue QJsonObject::const_iterator::operator[](int j) const
    error: out-of-line definition of 'operator[]' does not match any declaration in 'QJsonObject::const_iterator'
src/corelib/tools/qhash.cpp:2641: (qdoc) warning: Overrides a previous doc
src/corelib/tools/qhash.cpp:1492: (qdoc) warning: (The previous doc is here)
src/corelib/tools/qhash.cpp:2659: (qdoc) warning: Can't link to 'unit()'
src/corelib/text/qchar.cpp:274: (qdoc) warning: Undocumented enum item 'Script_Sundanese' in QChar::Script
src/corelib/text/qchar.cpp:274: (qdoc) warning: No such enum item 'Script_Sundaneseo' in QChar::Script
src/network/ssl/qsslsocket.cpp:1514: (qdoc) warning: Can't link to 'QSslConfiguration::addDefaultCaCertificate()'
src/widgets/widgets/qtabwidget.cpp:581: (qdoc) warning: Undocumented parameter 'visible' in QTabWidget::setTabVisible()

Change-Id: I05c2a4884873850b684fa94036cd90db1a6e7726
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
This commit is contained in:
Friedemann Kleint 2020-01-02 12:31:27 +01:00
parent 3a9251e869
commit 71477104eb
9 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
examples/widgets/widgets/icons/mainwindow.cpp
View File

@ -361,7 +361,7 @@ QWidget *MainWindow::createImagesGroupBox()
QVBoxLayout *layout = new QVBoxLayout(imagesGroupBox);
layout->addWidget(imagesTable);
return imagesGroupBox;
//! [25]
//! [24]
}
//! [26]

12
src/corelib/serialization/qjsonarray.cpp
View File

@ -175,12 +175,6 @@ void QJsonArray::initialize()
*/
QJsonArray::~QJsonArray() = default;
/*!
Creates a copy of \a other.
Since QJsonArray is implicitly shared, the copy is shallow
as long as the object doesn't get modified.
*/
QJsonArray::QJsonArray(std::initializer_list<QJsonValue> args)
{
initialize();
@ -188,6 +182,12 @@ QJsonArray::QJsonArray(std::initializer_list<QJsonValue> args)
append(arg);
}
/*!
Creates a copy of \a other.
Since QJsonArray is implicitly shared, the copy is shallow
as long as the object doesn't get modified.
*/
QJsonArray::QJsonArray(const QJsonArray &other)
{
a = other.a;

4
src/corelib/serialization/qjsonobject.cpp
View File

@ -1013,7 +1013,7 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const
Returns a pointer to a modifiable reference to the current item.
*/
/*! \fn QJsonValueRef QJsonObject::iterator::operator[](int j) const
/*! \fn const QJsonValueRef QJsonObject::iterator::operator[](int j)
Returns a modifiable reference to the item at offset \a j from the
item pointed to by this iterator (the item at position \c{*this + j}).
@ -1264,7 +1264,7 @@ QJsonObject::const_iterator QJsonObject::constFindImpl(T key) const
Returns a pointer to the current item.
*/
/*! \fn QJsonValue QJsonObject::const_iterator::operator[](int j) const
/*! \fn const QJsonValue QJsonObject::const_iterator::operator[](int j)
Returns the item at offset \a j from the item pointed to by this iterator (the item at
position \c{*this + j}).

6
src/corelib/serialization/qjsonvalue.cpp
View File

@ -149,7 +149,7 @@ QJsonValue::QJsonValue(bool b)
}
/*!
Creates a value of type Double, with value \a n.
Creates a value of type Double, with value \a v.
*/
QJsonValue::QJsonValue(double v)
: d(nullptr)
@ -164,7 +164,7 @@ QJsonValue::QJsonValue(double v)
/*!
\overload
Creates a value of type Double, with value \a n.
Creates a value of type Double, with value \a v.
*/
QJsonValue::QJsonValue(int v)
: n(v), t(QCborValue::Integer)
@ -173,7 +173,7 @@ QJsonValue::QJsonValue(int v)
/*!
\overload
Creates a value of type Double, with value \a n.
Creates a value of type Double, with value \a v.
NOTE: the integer limits for IEEE 754 double precision data is 2^53 (-9007199254740992 to +9007199254740992).
If you pass in values outside this range expect a loss of precision to occur.
*/

13
src/corelib/text/qbytearray.cpp
View File

@ -5175,7 +5175,7 @@ void warn(WarningType w, EmittingClass c)
*/
/*!
\fn QByteArray::FromBase64Result::operator QByteArray() const
\fn QByteArray &QByteArray::FromBase64Result::operator*() const
Returns the decoded byte array.
*/
@ -5184,17 +5184,18 @@ void warn(WarningType w, EmittingClass c)
\fn bool operator==(const QByteArray::FromBase64Result &lhs, const QByteArray::FromBase64Result &rhs) noexcept
\relates QByteArray::FromBase64Result
Compares \a lhs and \a rhs for equality. \a lhs and \a rhs are equal
if and only if they contain the same decoding status and, if the
status is QByteArray::Base64DecodingStatus::Ok, if and only if
they contain the same decoded data.
Returns \c true if \a lhs and \a rhs are equal, otherwise returns \c false.
\a lhs and \a rhs are equal if and only if they contain the same decoding
status and, if the status is QByteArray::Base64DecodingStatus::Ok, if and
only if they contain the same decoded data.
*/
/*!
\fn bool operator!=(const QByteArray::FromBase64Result &lhs, const QByteArray::FromBase64Result &rhs) noexcept
\relates QByteArray::FromBase64Result
Compares \a lhs and \a rhs for inequality.
Returns \c true if \a lhs and \a rhs are different, otherwise returns \c false.
*/
/*!

2
src/corelib/text/qchar.cpp
View File

@ -418,7 +418,7 @@ QT_BEGIN_NAMESPACE
\value Script_Sogdian Since Qt 5.15
\value Script_SoraSompeng
\value Script_Soyombo Since Qt 5.11
\value Script_Sundaneseo
\value Script_Sundanese
\value Script_SylotiNagri
\value Script_Syriac
\value Script_Tagalog

4
src/corelib/tools/qhash.cpp
View File

@ -2638,7 +2638,7 @@ uint qHash(long double key, uint seed) noexcept
\sa insert()
*/
/*! \fn template <class Key, class T> QList<Key> QHash<Key, T>::uniqueKeys() const
/*! \fn template <class Key, class T> QList<Key> QMultiHash<Key, T>::uniqueKeys() const
\since 5.13
Returns a list containing all the keys in the map. Keys that occur multiple
@ -2661,7 +2661,7 @@ uint qHash(long double key, uint seed) noexcept
Inserts all the items in the \a other hash into this hash
and returns a reference to this hash.
\sa unit(), insert()
\sa unite(), insert()
*/
/*! \fn template <class Key, class T> QMultiHash QMultiHash<Key, T>::operator+(const QMultiHash &other) const

2
src/network/ssl/qsslsocket.cpp
View File

@ -1526,7 +1526,7 @@ QList<QSslCertificate> QSslSocket::caCertificates() const
default CA certificate database.
\sa QSslConfiguration::caCertificates(), QSslConfiguration::addCaCertificates(),
QSslConfiguration::addDefaultCaCertificate()
QSslConfiguration::addCaCertificate()
*/
bool QSslSocket::addDefaultCaCertificates(const QString &path, QSsl::EncodingFormat encoding,
QRegExp::PatternSyntax syntax)

2
src/widgets/widgets/qtabwidget.cpp
View File

@ -579,7 +579,7 @@ bool QTabWidget::isTabVisible(int index) const
}
/*!
If \a enable is true, the page at position \a index is visible; otherwise the page at
If \a visible is true, the page at position \a index is visible; otherwise the page at
position \a index is hidden. The page's tab is redrawn appropriately.
\sa isTabVisible()