From 2cc458abfb2ab252d34bbdedcecf73ebd19335e5 Mon Sep 17 00:00:00 2001
From: Volker Hilsheimer <volker.hilsheimer@qt.io>
Date: Mon, 12 Apr 2021 13:21:51 +0200
Subject: [PATCH] Document QLocalSocket::socketOptions as a property

Change-Id: Ifda55ac7afb3fb30d973a01104b012959ae285ab
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
---
 src/network/socket/qlocalsocket.cpp | 13 +++++--------
 1 file changed, 5 insertions(+), 8 deletions(-)

diff --git a/src/network/socket/qlocalsocket.cpp b/src/network/socket/qlocalsocket.cpp
index 39c981c8d4..98c686de63 100644
--- a/src/network/socket/qlocalsocket.cpp
+++ b/src/network/socket/qlocalsocket.cpp
@@ -454,10 +454,13 @@ QString QLocalSocket::serverName() const
 }
 
 /*!
-    Returns the socket options as specified by setSocketOptions(),
+    \property QLocalSocket::socketOptions
+    \since 6.2
+    \brief the socket options.
+
+    Options must be set while the socket is in \l{UnconnectedState} state.
 
     \sa connectToServer()
-
  */
 QLocalSocket::SocketOptions QLocalSocket::socketOptions() const
 {
@@ -465,12 +468,6 @@ QLocalSocket::SocketOptions QLocalSocket::socketOptions() const
     return d->socketOptions;
 }
 
-/*!
-    \since 6.2
-
-    Set the socket \a options of the connection.
-
-*/
 void QLocalSocket::setSocketOptions(QLocalSocket::SocketOptions option)
 {
     Q_D(QLocalSocket);