kosslan/quickshell
1
0
Fork 0
forked from quickshell/quickshell
Code Pull requests Activity

docs: use new member reference shorthand

Browse source
This commit is contained in:
outfoxxed 2024-07-21 17:41:49 -07:00
parent dfcf533424
commit a9e4720fae
Signed by: outfoxxed
GPG key ID: 4C88A185FB89301E
35 changed files with 182 additions and 146 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/io/socket.hpp
View file

@ -23,7 +23,7 @@ class Socket: public DataStream {
/// update the property immediately. Setting the property to false will begin disconnecting
/// the socket, and setting it to true will begin connecting the socket if path is not empty.
Q_PROPERTY(bool connected READ isConnected WRITE setConnected NOTIFY connectionStateChanged);
/// The path to connect this socket to when `connected` is set to true.
/// The path to connect this socket to when @@connected is set to true.
///
/// Changing this property will have no effect while the connection is active.
Q_PROPERTY(QString path READ path WRITE setPath NOTIFY pathChanged);
@ -105,9 +105,9 @@ class SocketServer
///
/// Setting this property while the server is active will have no effect.
Q_PROPERTY(QString path READ path WRITE setPath NOTIFY pathChanged);
/// Connection handler component. Must creeate a `Socket`.
/// Connection handler component. Must creeate a @@Socket.
///
/// The created socket should not set `connected` or `path` or the incoming
/// The created socket should not set @@connected or @@path or the incoming
/// socket connection will be dropped (they will be set by the socket server.)
/// Setting `connected` to false on the created socket after connection will
/// close and delete it.