server doxygen

Add documentation to the server

server/websocket.hpp

@@ -1,29 +1,84 @@
 #pragma once
-#include <QtCore/QByteArray>
 #include <QtCore/QList>
 #include <QtCore/QObject>
 
 QT_FORWARD_DECLARE_CLASS(QWebSocketServer)
 QT_FORWARD_DECLARE_CLASS(QWebSocket)
 
+/**
+ * @brief Class managing a WebSocket server
+ *
+ */
 class Websocket : public QObject
 {
     Q_OBJECT
 
   public:
+    /**
+     * @brief Construct a new Websocket object
+     *
+     * @param port The port to listen on
+     * @param parent The parent QObject
+     */
     Websocket(uint16_t port, QObject *parent = nullptr);
+    /**
+     * @brief Construct a new Websocket object with SSL
+     *
+     * @param port The port to listen on
+     * @param key_file The path to the SSL key file
+     * @param cert_file The path to the SSL certificate file
+     * @param parent The parent QObject
+     */
     Websocket(uint16_t port, QString key_file, QString cert_file, QObject *parent = nullptr);
+    /**
+     * @brief Destroy the Websocket object
+     *
+     */
     ~Websocket();
 
+    /**
+     * @brief Broadcast a message to all connected clients
+     *
+     * @param message The message to send
+     */
     void broadcast(QString message);
+    /**
+     * @brief Send a message to a specific client
+     *
+     * @param conn The client connection
+     * @param message The message to send
+     */
     void send(QWebSocket *conn, QString message);
   signals:
+    /**
+     * @brief Signal emitted when a message is received from a client
+     *
+     * @param conn The client connection
+     * @param message The received message
+     */
     void on_message(QWebSocket *conn, QString message);
+    /**
+     * @brief Signal emitted when the server is closed
+     *
+     */
     void closed();
 
   private slots:
+    /**
+     * @brief Private Slot called when a new client connection is established
+     *
+     */
     void onNewConnection();
+    /**
+     * @brief Private Slot called when a text message is received from a client
+     *
+     * @param message The received message
+     */
     void processTextMessage(QString message);
+    /**
+     * @brief Private Slot called when a client disconnects
+     *
+     */
     void socketDisconnected();
 
   private: