GPT fix

Author: BenjaminDannegard

libraries/WiFiS3/src/StringHelpers.h

@@ -58,8 +58,7 @@ void split(std::vector<std::string> &res, std::string &str, const std::string &d
  * This function attempts to remove the first occurrence of the specified substring 
  * (`what`) from the beginning of the string (`str`). Before performing the removal, 
  * it trims leading whitespace from the string. If the substring is found at the 
- * beginning of the string, it is removed, and the function returns `true`. If the 
- * substring is not found at the beginning, the string remains unchanged, and the 
+ * beginning of the string, it is removed, and the function returns `true`. Otherwise the 
  * function returns `false`.
  *
  * @param `str` is a reference to the string from which the substring will be removed. 

libraries/WiFiS3/src/WiFiClient.h

@@ -33,52 +33,122 @@
 class WiFiClient : public Client {
 
 public:
+  /**
+   * @brief Default constructor for the WiFiClient class.
+   */
   WiFiClient();
+
   /* this constructor is not intended to be called outside of the Server class */
+  /**
+   * @brief Constructor to initialize a WiFiClient object with a specific socket.
+   *
+   * @param `s` is the socket descriptor to associate with this client.
+   */
   WiFiClient(int s);
+
+  /**
+   * @brief Copy constructor for the WiFiClient class.
+   *
+   * @param `c` is the `WiFiClient` object to copy.
+   */
   WiFiClient(const WiFiClient& c);
   ~WiFiClient();
 
+
   /**
-   * @brief Establish a connection to a remote server using the specified IP address and port number.
+ * @brief Establishes a connection to a server using an IP address and port.
+ *
+ * This function initiates a connection to a server using the specified IP address 
+ * and port. Internally, it converts the IP address to a string and delegates 
+ * the connection task to the `connect(const char*, uint16_t)` method.
+ *
+ * @param ip The IP address of the server to connect to.
+ * @param port The port number on the server to connect to.
+ * 
+ * @return `1` on a successful connection, `0` on failure.
+ */
+
+  /**
+   * @brief Establishes a connection to a server using an IP address and port.
+   *
+   * @param Using `ip` as the IP address of the server to connect to.
+   * And `port` as the port number on the server to connect to.
+   * 
+   * @return `1` on a successful connection, `0` on failure.
    */
   virtual int connect(IPAddress ip, uint16_t port);
 
   /**
-   * @brief Establish a connection to a remote server.
+   * @brief Establishes a connection to a server using a hostname and port.
    * 
-   * @param Uses the specified domain name or IP address `host` and `port` for port number.
+   * @param `host` is a pointer to a null-terminated string containing the hostname of the server.
+   * And `port` is the port number on the server to connect to.
+   * 
+   * @return `1` if the connection was successful, `0` otherwise.
    */
   virtual int connect(const char *host, uint16_t port);
-  
+
   /** 
-   * @brief Writes a single byte of data to the connected client.
+   * @brief Sends a single byte of data to the connected server.
+   *
+   * @param `b` being the byte of data to send.
+   * 
+   * @return The number of bytes successfully written, which is `1` on success or `0` on failure.
    */
   virtual size_t write(uint8_t);
 
   /** 
-   * @brief Writes a buffer of data to the connected client.
+   * @brief Writes a buffer of data to the connected server.
    * 
    * @param Takes a pointer to a buffer `buf` containing the data to be written
    * and the size of the buffer `size` as parameters.
    * 
-   * @return The function writes the data in the buffer to the connected client
-   * and returns the number of bytes written.
+   * @return The number of bytes successfully written, or `0` if the write operation fails.
    */
   virtual size_t write(const uint8_t *buf, size_t size);
 
   /**
-   * @brief Checks how many bytes are available for reading from the connected client.
+   * @brief Checks the number of bytes available for reading from the server.
+   *
+   * @return The number of bytes available to read. Returns `0` if no data is 
+   * available, or if the socket is invalid.
    */
   virtual int available();
 
   /**
-   * @brief Reads a single byte of data from the connected client.
+   * @brief Reads a single byte of data from the server.
+   *
+   * @return The byte read as an `int` (0–255). Returns `-1` if no data is available 
+   * or if an error occurs.
    */
   virtual int read();
 
   /**
-   * @brief Reads a specified number of bytes from the connected client into a buffer.
+ * @brief Reads multiple bytes of data from the server into a buffer.
+ *
+ * This function retrieves data from the server's receive buffer and stores it 
+ * into the provided array. It attempts to read up to the specified number of 
+ * bytes (`size`). The function stops reading if no more data is available or 
+ * if an error occurs.
+ *
+ * @param[out] buf Pointer to the buffer where the data will be stored.
+ * @param[in] size Maximum number of bytes to read.
+ * @return The number of bytes successfully read into the buffer. 
+ * Returns `0` if no data is available or if the socket is invalid.
+ */
+
+  /**
+   * @brief Reads multiple bytes of data from the server into a buffer.
+   *
+   * This function retrieves data from the server's receive buffer and stores it 
+   * into the provided array. It attempts to read up to the specified number of 
+   * bytes (`size`).
+   *
+   * @param[out] `buf` is a pointer to the buffer where the data will be stored.
+   * @param[in] `size` is the maximum number of bytes to read.
+   *
+   * @return The number of bytes successfully read into the buffer. 
+   * Returns `0` if no data is available or if the socket is invalid.
    */
   virtual int read(uint8_t *buf, size_t size);