summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVolker Hilsheimer <volker.hilsheimer@qt.io>2021-04-12 13:21:51 +0200
committerVolker Hilsheimer <volker.hilsheimer@qt.io>2021-04-13 10:48:01 +0200
commit2cc458abfb2ab252d34bbdedcecf73ebd19335e5 (patch)
tree10ed2ca85cde6804544f42e509456dd7a56ccf27
parent409443a376daf6248987b6864c46387c485dd3ed (diff)
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>
-rw-r--r--src/network/socket/qlocalsocket.cpp13
1 files 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.
- \sa connectToServer()
+ 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);