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

Doc: Fix documentation warnings for Qt Network

Browse Source 
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>
This commit is contained in:
Topi Reinio 2021-09-08 12:13:21 +02:00
parent c138f55591
commit 1117e732d9
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/network/access/qnetworkaccessbackend.cpp
View File

@ -133,14 +133,14 @@ QStringList QNetworkAccessManagerPrivate::backendSupportedSchemes() const
\since 6.0 \since 6.0
\internal \internal
//![semi-private-notice] //! [semi-private-notice]
The class is considered semi-private and as such requires linking The class is considered semi-private and as such requires linking
to "NetworkPrivate" to access the header. Furthermore it means to "NetworkPrivate" to access the header. Furthermore it means
the class is not under the same binary compatibility restrictions the class is not under the same binary compatibility restrictions
as the rest of Qt. While we still try to avoid breakage it may 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 still occur. The class is primarily meant to be used by plugins
which would be recompiled every time Qt is updated. 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 This class acts as the primary interface to the plugin and must
be derived from. It deals with both querying supported schemes be derived from. It deals with both querying supported schemes
@ -177,7 +177,7 @@ QStringList QNetworkAccessManagerPrivate::backendSupportedSchemes() const
\since 6.0 \since 6.0
\internal \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 This class can be derived from to add support for further schemes
in QNetworkAccessManager. in QNetworkAccessManager.

5
src/network/socket/qabstractsocket.h
View File

@ -44,6 +44,9 @@
#if QT_VERSION >= QT_VERSION_CHECK(7, 0, 0) #if QT_VERSION >= QT_VERSION_CHECK(7, 0, 0)
#include <QtNetwork/qabstractsocket.h> #include <QtNetwork/qabstractsocket.h>
#endif #endif
#ifdef Q_CLANG_QDOC
#include <QtNetwork/qhostaddress.h>
#endif
#include <QtCore/qiodevice.h> #include <QtCore/qiodevice.h>
#include <QtCore/qobject.h> #include <QtCore/qobject.h>
#ifndef QT_NO_DEBUG_STREAM #ifndef QT_NO_DEBUG_STREAM
@ -166,7 +169,7 @@ public:
bool bind(QHostAddress::SpecialAddress addr, quint16 port = 0, BindMode mode = DefaultForPlatform) bool bind(QHostAddress::SpecialAddress addr, quint16 port = 0, BindMode mode = DefaultForPlatform)
{ return bind(QHostAddress(addr), port, mode); } { return bind(QHostAddress(addr), port, mode); }
bool bind(quint16 port = 0, BindMode mode = DefaultForPlatform) bool bind(quint16 port = 0, BindMode mode = DefaultForPlatform)
{ retrurn bind(QHostAddress::Any, port, mode); } { return bind(QHostAddress::Any, port, mode); }
#else #else
bool bind(quint16 port = 0, BindMode mode = DefaultForPlatform); bool bind(quint16 port = 0, BindMode mode = DefaultForPlatform);
#endif #endif