Add documentation

Author: sebromero

src/ArduinoCellular.h

@@ -236,15 +236,17 @@ class ArduinoCellular {
 #endif
 
         /**
-         * @brief Gets the HTTP client for the specified server and port.
+         * @brief Gets a HTTP client for the specified server and port.
+         * The maximum number of HTTP clients is limited by the number of sockets available.
          * @param server The server address.
          * @param port The server port.
          * @return The HTTP client.
          */
         HttpClient getHTTPClient(const char * server, const int port);
 
         /**
-         * @brief Gets the HTTPS client for the specified server and port.
+         * @brief Gets a HTTPS client for the specified server and port.
+         * The maximum number of HTTP clients is limited by the number of sockets available.
          * @param server The server address.
          * @param port The server port.
          * @return The HTTPS client.

src/ManagedTinyGsmClient.h

@@ -3,6 +3,12 @@
 
 #include "ModemInterface.h"
 
+/**
+ * @class ManagedTinyGsmClient
+ * @brief A managed client for TinyGSM that automatically handles socket allocation and release.
+ * This class allows you to create multiple clients without worrying about socket management.
+ * It uses a static bit field to track used sockets and provides methods to lock and unlock the sockets.
+ */
 class ManagedTinyGsmClient : public TinyGsmClient {
 private:
     int socketId;
@@ -15,14 +21,62 @@ class ManagedTinyGsmClient : public TinyGsmClient {
     static void unlockSockets();
 
 public:
+    /**
+     * @brief Constructs a ManagedTinyGsmClient with the specified modem.
+     * @param modem The TinyGsm modem to use.
+     */
     ManagedTinyGsmClient(TinyGsm& modem);
+
+    /**
+     * Copy constructor for ManagedTinyGsmClient.
+     * This constructor allocates a new socket for the copied client.
+     * @param other The other ManagedTinyGsmClient to copy from.
+     * Note: If the other client is invalid, this will also create an invalid client.
+     * The socketId will be -1.
+     */
     ManagedTinyGsmClient(const ManagedTinyGsmClient& other);
+
+    /**
+     * Assignment operator for ManagedTinyGsmClient.
+     * @param other The other ManagedTinyGsmClient to copy from.
+     * @return A reference to this ManagedTinyGsmClient.
+     */
     ManagedTinyGsmClient& operator=(const ManagedTinyGsmClient& other);
+
+    /**
+     * Move constructor for ManagedTinyGsmClient.
+     * @param other The other ManagedTinyGsmClient to move from.
+     */
     ManagedTinyGsmClient(ManagedTinyGsmClient&& other);
+
+    /**
+     * Move assignment operator for ManagedTinyGsmClient.
+     * This operator transfers ownership of the socket from the other client to this one.
+     * @param other The other ManagedTinyGsmClient to move from.
+     * @return A reference to this ManagedTinyGsmClient.
+     */
     ManagedTinyGsmClient& operator=(ManagedTinyGsmClient&& other);
+
+    /**
+     * Destructor for ManagedTinyGsmClient.
+     * Releases the socket if it is valid.
+     */
     ~ManagedTinyGsmClient();
 
+    /**
+     * Get the socket ID for this client.
+     * The maximum number of sockets is defined by TINY_GSM_MUX_COUNT.
+     * If the client is invalid, the socketId will be -1.
+     * @return The socket ID (0 - (TINY_GSM_MUX_COUNT - 1) or -1 if invalid).
+     */
     int getSocketId() const { return socketId; }
+
+    /**
+     * Check if the client is valid.
+     * A client is valid if it has a socket ID >= 0.
+     * This is useful to check if the client can be used for network operations.
+     * @return True if the client is valid, false otherwise.
+     */
     bool isValid() const { return socketId >= 0; }
 };