From ea9716949d80fcbc50301bc2375e1b63579354be Mon Sep 17 00:00:00 2001
From: Cerapter <cerap@protonmail.com>
Date: Sun, 14 Mar 2021 19:34:40 +0100
Subject: [PATCH] Document WSProxy

---
 include/ws_proxy.h | 45 +++++++++++++++++++++++++++++++++++++++++++++
 src/ws_proxy.cpp   |  7 ++++---
 2 files changed, 49 insertions(+), 3 deletions(-)

diff --git a/include/ws_proxy.h b/include/ws_proxy.h
index 440d453..a808b77 100644
--- a/include/ws_proxy.h
+++ b/include/ws_proxy.h
@@ -25,21 +25,66 @@
 #include <QtWebSockets/QtWebSockets>
 #include <QHostAddress>
 
+/**
+ * @brief Handles WebSocket connections by redirecting data sent through them through a local TCP connection
+ * for common handling.
+ */
 class WSProxy : public QObject {
     Q_OBJECT
   public:
+    /**
+     * @brief Creates a WSProxy instance.
+     *
+     * @param p_local_port The port through which the TCP connection should be directed. Should the same as with
+     * non-WebAO connections.
+     * @param p_ws_port The WebSocket port. Should the same that is opened for WebSockets connections.
+     * @param p_parent Qt-based parent, passed along to inherited constructor from QObject.
+     */
     WSProxy(int p_local_port, int p_ws_port, QObject* parent);
+
+    /**
+      * @brief Destructor for the WSProxy class.
+      *
+      * @details Marks the WebSocket server that is used to handle the proxy process to be deleted later.
+      */
     ~WSProxy();
 
+    /**
+     * @brief Starts listening for WebSocket connections on the given port.
+     */
     void start();
+
 public slots:
+    /**
+     * @brief Sets up the proxy process to the newly connected WebSocket.
+     *
+     * @details This function creates a TCP socket to establish the proxy, creates a WSClient to represent the client connecting through WebSocket.
+     */
     void wsConnected();
 
   private:
+    /**
+     * @brief The WebSocket server listening to incoming WebSocket connections.
+     */
     QWebSocketServer* server;
+
+    /**
+     * @brief Every client connected through WebSocket.
+     */
     QVector<WSClient*> clients;
 
+    /**
+     * @brief The TCP port that the WebSocket connections will be redirected through.
+     *
+     * @note Should be the same that desktop clients connect through, and that was announced to the master server.
+     */
     int local_port;
+
+    /**
+     * @brief The port for incoming WebSocket connections.
+     *
+     * @note Should be the same that was announced to the master server.
+     */
     int ws_port;
 };
 
diff --git a/src/ws_proxy.cpp b/src/ws_proxy.cpp
index 619b434..0dd412f 100644
--- a/src/ws_proxy.cpp
+++ b/src/ws_proxy.cpp
@@ -17,10 +17,11 @@
 //////////////////////////////////////////////////////////////////////////////////////
 #include "include/ws_proxy.h"
 
-WSProxy::WSProxy(int p_local_port, int p_ws_port, QObject* parent) : QObject(parent)
+WSProxy::WSProxy(int p_local_port, int p_ws_port, QObject* parent) :
+    QObject(parent),
+    local_port(p_local_port),
+    ws_port(p_ws_port)
 {
-    local_port = p_local_port;
-    ws_port = p_ws_port;
     server = new QWebSocketServer(QStringLiteral(""),
                                   QWebSocketServer::NonSecureMode, this);
     connect(server, &QWebSocketServer::newConnection, this,