Api docs

Author: BenjaminDannegard

libraries/WiFiS3/src/WiFiSSLClient.h

@@ -29,20 +29,85 @@
 class WiFiSSLClient : public WiFiClient {
 
 public:
+   /**
+    * Initializes objects of the `WiFiSSLClient` class.
+    */
    WiFiSSLClient();
    ~WiFiSSLClient();
+
+   /**
+    * Establishes a secure SSL connection to a specified IP address and port.
+    * It takes an `IPAddress` object representing the IP address of the server
+    * and a `uint16_t` port number as parameters.
+    */
    virtual int connect(IPAddress ip, uint16_t port);
+
+   /**
+    * Establishes a secure SSL connection to a specified host (domain name) and port.
+    */
    virtual int connect(const char* host, uint16_t port);
+
+   /**
+    * Sets the Certificate Authority (CA) certificate for establishing secure SSL connections.
+    */
    void setCACert(const char* root_ca);
+
+   /**
+    * Sets the ECC (Elliptic Curve Cryptography) key slot and 
+    * certificate for establishing secure SSL connections.
+    * `int ecc508KeySlot` specifies the ECC key slot to be used for the SSL connection.
+    * `const byte cert[]` is a pointer to the certificate data in the form of an array of bytes.
+    * `int certLength` specifies the length of the certificate data array.
+    */
    void setEccSlot(int ecc508KeySlot, const byte cert[], int certLength);
+   
+   /**
+    * Allows writing a single byte of data to the SSL connection.
+    * The `uint8_t` parameter represents the byte of data to be written.
+    */
    virtual size_t write(uint8_t);
+
+   /**
+    * Allows writing a buffer of data to the SSL connection.
+    */
    virtual size_t write(const uint8_t *buf, size_t size);
+   
+   /**
+    * Checks the number of bytes available for reading from the SSL connection.
+    * It returns the number of bytes available to read from the SSL connection without blocking.
+    */
    virtual int available();
+
+   /**
+    * Reads a single byte of data from the SSL connection.
+    */
    virtual int read();
+
+   /**
+    * Reads a buffer of data from the SSL connection.
+    */
    virtual int read(uint8_t *buf, size_t size);
+
+   /**
+    * Peeks at the next byte of incoming data without removing it
+    * from the internal buffer of the SSL connection.
+    */
    virtual int peek();
+
+   /**
+    * Flushes any pending data in the SSL connection.
+    * When called, this function ensures that any buffered outgoing data is
+    * sent over the SSL connection immediately.
+    */
    virtual void flush();
+
+   /**
+    * Closes the SSL connection.
+    * When called, this function will terminate the SSL connection and
+    * release any associated resources.
+    */
    virtual void stop();
+   
    virtual uint8_t connected();
    virtual operator bool() {
       return _sock != -1;

libraries/WiFiS3/src/WiFiServer.h

@@ -34,14 +34,42 @@ class WiFiServer : public Server {
   WiFiClient client;
 
 public:
+  /**
+   * Initializes a `WiFiServer` object.
+   */
   WiFiServer();
   WiFiServer(int p);
+
+  /**
+   * Checks if there are any incoming client connections waiting to be accepted.
+   * It returns a `WiFiClient` object representing the next client connection that is available
+   * for processing.
+   */
   WiFiClient available();
+
+  /**
+   * Accepts and returns a new client connection that is waiting to be processed.
+   * When called, it will accept the next incoming client connection and
+   * return a `WiFiClient` object representing that connection.
+   */
   WiFiClient accept();
+
+  /**
+   * Initializes the WiFi server on a specific port.
+   * When this function is called with a port number as an argument,
+   * it sets up the server to listen for incoming client connections on that specified port.
+   */
   void begin(int port);
+  
   void begin();
   virtual size_t write(uint8_t);
   virtual size_t write(const uint8_t *buf, size_t size);
+
+  /**
+   * Closes the server and release any resources associated with it.
+   * When you call `end()`, it stops the server from listening for incoming client connections
+   * and cleans up any allocated memory or resources.
+   */
   void end();
   explicit operator bool();
   virtual bool operator==(const WiFiServer&);