From 1117e732d9fd2537edf2bf2fad54d187c6664b67 Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@qt.io>
Date: Wed, 8 Sep 2021 12:13:21 +0200
Subject: Doc: Fix documentation warnings for Qt Network
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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>
---
 src/network/socket/qabstractsocket.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'src/network/socket')

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
-- 
cgit v1.2.3