diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2021-09-08 12:13:21 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2021-09-08 18:31:18 +0200 |
| commit | 1117e732d9fd2537edf2bf2fad54d187c6664b67 (patch) | |
| tree | 37f57faf58a747dd9e519782c108ed191639c050 | |
| parent | c138f55591ff916bad51ff3f80350df0587b1115 (diff) | |
Doc: Fix documentation warnings for Qt Network
The Clang compiler used in QDoc complained about the documentation-
specific overload of QAbstractSocket::bind():
error: incomplete type 'QHostAddress' named in nested name specifier
Also, fix an attempted snippet inclusion to use the \include command,
and fix the comment tag spacing and indentation.
Pick-to: 6.2
Fixes: QTBUG-96293
Change-Id: Ie4d78933fa7ac0aaf7f3bcc6487e7fd823db5123
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
| -rw-r--r-- | src/network/access/qnetworkaccessbackend.cpp | 6 | ||||
| -rw-r--r-- | src/network/socket/qabstractsocket.h | 5 |
2 files changed, 7 insertions, 4 deletions
diff --git a/src/network/access/qnetworkaccessbackend.cpp b/src/network/access/qnetworkaccessbackend.cpp index acac03220a..b544e8436b 100644 --- a/src/network/access/qnetworkaccessbackend.cpp +++ b/src/network/access/qnetworkaccessbackend.cpp @@ -133,14 +133,14 @@ QStringList QNetworkAccessManagerPrivate::backendSupportedSchemes() const \since 6.0 \internal - //![semi-private-notice] +//! [semi-private-notice] The class is considered semi-private and as such requires linking to "NetworkPrivate" to access the header. Furthermore it means the class is not under the same binary compatibility restrictions as the rest of Qt. While we still try to avoid breakage it may still occur. The class is primarily meant to be used by plugins which would be recompiled every time Qt is updated. - //![semi-private-notice] +//! [semi-private-notice] This class acts as the primary interface to the plugin and must be derived from. It deals with both querying supported schemes @@ -177,7 +177,7 @@ QStringList QNetworkAccessManagerPrivate::backendSupportedSchemes() const \since 6.0 \internal - \snippet qnetworkaccessbackend.cpp semi-private-notice + \include access/qnetworkaccessbackend.cpp semi-private-notice This class can be derived from to add support for further schemes in QNetworkAccessManager. diff --git a/src/network/socket/qabstractsocket.h b/src/network/socket/qabstractsocket.h index 96b86f63f7..03baa879aa 100644 --- a/src/network/socket/qabstractsocket.h +++ b/src/network/socket/qabstractsocket.h @@ -44,6 +44,9 @@ #if QT_VERSION >= QT_VERSION_CHECK(7, 0, 0) #include <QtNetwork/qabstractsocket.h> #endif +#ifdef Q_CLANG_QDOC +#include <QtNetwork/qhostaddress.h> +#endif #include <QtCore/qiodevice.h> #include <QtCore/qobject.h> #ifndef QT_NO_DEBUG_STREAM @@ -166,7 +169,7 @@ public: bool bind(QHostAddress::SpecialAddress addr, quint16 port = 0, BindMode mode = DefaultForPlatform) { return bind(QHostAddress(addr), port, mode); } bool bind(quint16 port = 0, BindMode mode = DefaultForPlatform) - { retrurn bind(QHostAddress::Any, port, mode); } + { return bind(QHostAddress::Any, port, mode); } #else bool bind(quint16 port = 0, BindMode mode = DefaultForPlatform); #endif |