Fixed for formating

Author: BenjaminDannegard

libraries/WiFiS3/src/Modem.h

@@ -28,7 +28,7 @@ class ModemClass {
   /** 
    * @brief Constructor for the ModemClass, which initializes the modem with the specified transmit (TX) and receive (RX) pins.
    * 
-   * @param Initializes an instance of the `ModemClass` class with
+   * @param Initializes an instance of the ModemClass class with
    * specific transmit `tx` and receive `rx` pins for communication.
    */
   ModemClass(int tx, int rx);

libraries/WiFiS3/src/WiFi.h

@@ -36,7 +36,7 @@ class CAccessPoint {
 /**
  * @brief Class to manage Wi-Fi connectivity and operations.
  * 
- * The `CWifi` class provides an interface to manage Wi-Fi operations such as connecting 
+ * The CWifi class provides an interface to manage Wi-Fi operations such as connecting 
  * to networks, setting up an access point, retrieving network information, and more. 
  * It interfaces with a modem to execute commands related to Wi-Fi functionality and manages 
  * connection settings such as IP address, DNS, and other network configurations.

libraries/WiFiS3/src/WiFiClient.h

@@ -34,12 +34,12 @@
 /**
  * @brief Represents a Wi-Fi client that connects to a remote server over a Wi-Fi network.
  * 
- * The `WiFiClient` class allows for network communication over Wi-Fi, providing methods 
+ * The WiFiClient class allows for network communication over Wi-Fi, providing methods 
  * for establishing connections, sending and receiving data, and managing the client’s 
  * socket state. This class is used to manage client connections in a Wi-Fi network, 
  * either for communication or for network data transfer.
  * 
- * It inherits from the `Client` class, providing basic socket communication functionality.
+ * It inherits from the Client class, providing basic socket communication functionality.
  */
 class WiFiClient : public Client {
 
@@ -231,17 +231,17 @@ class WiFiClient : public Client {
   }
 
   /**
-   * @brief Declares `WiFiServer` as a friend class.
+   * @brief Declares WiFiServer as a friend class.
    * 
-   * This allows the `WiFiServer` class to access private and protected members 
-   * of the `WiFiClient` class.
+   * This allows the WiFiServer class to access private and protected members 
+   * of the WiFiClient class.
    */
   friend class WiFiServer;
 
   /**
    * @brief Inherits the `write` method from the `Print` class.
    * 
-   * This allows the `WiFiSSLClient` class to use the `write` method defined in the 
+   * This allows the WiFiSSLClient class to use the `write` method defined in the 
    * `Print` class.
    */
   using Print::write;

libraries/WiFiS3/src/WiFiFileSystem.h

@@ -34,7 +34,7 @@ class WiFiFileSystem {
 
 public:
    /**
-    * @brief Initializes objects of the `WiFiFileSystem` class.
+    * @brief Initializes objects of the WiFiFileSystem class.
     */
    WiFiFileSystem();
 

libraries/WiFiS3/src/WiFiSSLClient.h

@@ -28,15 +28,15 @@
 /**
  * @brief A specialized client class for secure SSL/TLS connections.
  * 
- * The `WiFiSSLClient` class extends the functionality of the `WiFiClient` class to provide secure
+ * The WiFiSSLClient class extends the functionality of the WiFiClient class to provide secure
  * communication over SSL/TLS protocols. It ensures encrypted and authenticated communication
  * between the client and a remote server.
  */
 class WiFiSSLClient : public WiFiClient {
 
 public:
    /**
-    * @brief Initializes objects of the `WiFiSSLClient` class.
+    * @brief Initializes objects of the WiFiSSLClient class.
     */
    WiFiSSLClient();
    ~WiFiSSLClient();
@@ -58,7 +58,7 @@ class WiFiSSLClient : public WiFiClient {
     * @param `host` is the hostname or IP address of the server to connect to.
     * `port` is the port number to connect to.
     * 
-    * @return Returns 1 if the connection is successfully established, 0 otherwise.
+    * @return Returns `1` if the connection is successfully established, `0` otherwise.
     */
    virtual int connect(const char* host, uint16_t port);
 
@@ -76,8 +76,8 @@ class WiFiSSLClient : public WiFiClient {
     * certificate for establishing secure SSL connections.
     * 
     * @param `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.
+    * @param `const byte cert[]` is a pointer to the certificate data in the form of an array of bytes.
+    * @param `int certLength` specifies the length of the certificate data array.
     */
    void setEccSlot(int ecc508KeySlot, const byte cert[], int certLength);
 
@@ -86,19 +86,19 @@ class WiFiSSLClient : public WiFiClient {
     * 
     * @param `b` is the byte to be sent.
     * 
-    * @return size_t The number of bytes successfully written. Returns 1 if the byte 
-    * was sent successfully, or 0 if an error occurred.
+    * @return The number of bytes successfully written. Returns `1` if the byte 
+    * was sent successfully, or `0` if an error occurred.
     */
    virtual size_t write(uint8_t);
 
    /**
     * @brief Writes a buffer of data to the SSL connection.
     *
     * @param `buf` is a pointer to the buffer containing the data to be sent.
-    * `size` is the number of bytes to send from the buffer.
+    * @param `size` is the number of bytes to send from the buffer.
     *
     * @return Returns `size` if the data is successfully sent, 
-    * or 0 if the transmission fails or the socket is invalid.
+    * or `0` if the transmission fails or the socket is invalid.
     */
    virtual size_t write(const uint8_t *buf, size_t size);
 
@@ -113,7 +113,7 @@ class WiFiSSLClient : public WiFiClient {
     * @brief Reads data from the SSL connection into the receive buffer.
     *
     * @return Returns the number of bytes successfully read into the buffer. Returns 
-    * 0 if no data is received, or -1 if the socket is invalid or an error occurs.
+    * `0` if no data is received, or `-1` if the socket is invalid or an error occurs.
     */
    virtual int read();
 
@@ -123,7 +123,7 @@ class WiFiSSLClient : public WiFiClient {
     * @param `buf` is a pointer to the buffer where the read data will be stored.
     * `size` is the maximum number of bytes to read into the buffer.
     *
-    * @return The number of bytes successfully read. Returns 0 if no data is 
+    * @return The number of bytes successfully read. Returns `0` if no data is 
     * available or an error occurs.
     */
    virtual int read(uint8_t *buf, size_t size);
@@ -134,7 +134,7 @@ class WiFiSSLClient : public WiFiClient {
     * This function queries the modem to retrieve the next byte available in the 
     * SSL/TLS connection, allowing the byte to remain in the buffer for future reads.
     *
-    * @return The next byte available as an integer value (0–255), or -1 if 
+    * @return The next byte available as an integer value (0–255), or `-1` if 
     * the socket is invalid or no data is available.
     */
    virtual int peek();
@@ -159,7 +159,7 @@ class WiFiSSLClient : public WiFiClient {
     * the modem for the connection status. It checks the validity of the socket 
     * before proceeding with the query.
     *
-    * @return uint8_t Returns 1 if the client is connected, 0 otherwise.
+    * @return Returns `1` if the client is connected, `0` otherwise.
     */
    virtual uint8_t connected();
 
@@ -177,7 +177,7 @@ class WiFiSSLClient : public WiFiClient {
     * 
     * @param `WiFiSSLClient` object to compare.
     * 
-    * @return `true` if both `WiFiSSLClient` objects are equivalent (i.e., they have the same socket),
+    * @return `true` if both WiFiSSLClient objects are equivalent (i.e., they have the same socket),
     * `false` otherwise.
     */
    virtual bool operator==(const WiFiSSLClient&);
@@ -189,7 +189,7 @@ class WiFiSSLClient : public WiFiClient {
     * to determine if they are not equal, based on their underlying socket or connection.
     * 
     * @param `whs` The WiFiSSLClient object to compare with.
-    * @return `true` if the two `WiFiSSLClient` objects do not represent the same connection (i.e., have different sockets),
+    * @return `true` if the two WiFiSSLClient objects do not represent the same connection (i.e., have different sockets),
     * `false` otherwise.
     */
    virtual bool operator!=(const WiFiSSLClient& whs)
@@ -203,7 +203,7 @@ class WiFiSSLClient : public WiFiClient {
     * This function queries the modem for the remote IP address associated with 
     * the current connection.
     *
-    * @return The remote IP address of the client. Returns 0.0.0.0 if the 
+    * @return The remote IP address of the client. Returns `0.0.0.0` if the 
     * socket is not valid or the query fails.
     */
    virtual IPAddress remoteIP();
@@ -214,25 +214,25 @@ class WiFiSSLClient : public WiFiClient {
     * This function queries the modem to obtain the remote port number associated 
     * with the current connection.
     *
-    * @return Returns the remote port number of the client. Returns 0 if the socket 
+    * @return Returns the remote port number of the client. Returns `0` if the socket 
     * is not valid or the query fails.
     */
    virtual uint16_t remotePort();
 
 
    /**
-    * @brief Declares `WiFiServer` as a friend class.
+    * @brief Declares WiFiServer as a friend class.
     * 
-    * This allows the `WiFiServer` class to access private and protected members 
-    * of the `WiFiSSLClient` class.
+    * This allows the WiFiServer class to access private and protected members 
+    * of the WiFiSSLClient class.
     */
    friend class WiFiServer;
 
    /**
-    * @brief Inherits the `write` method from the `Print` class.
+    * @brief Inherits the `write` method from the Print class.
     * 
-    * This allows the `WiFiSSLClient` class to use the `write` method defined in the 
-    * `Print` class.
+    * This allows the WiFiSSLClient class to use the `write` method defined in the 
+    * Print class.
     */
    using Print::write;
 

libraries/WiFiS3/src/WiFiServer.h

@@ -29,7 +29,7 @@
 /**
  * @brief A class that provides server functionality for WiFi-based communication.
  * 
- * The `WiFiServer` class inherits from the `Server` class and extends its functionality 
+ * The WiFiServer class inherits from the Server class and extends its functionality 
  * to create and manage a server over a WiFi connection. This class allows for accepting 
  * incoming client connections, handling data communication, and closing connections 
  * in a networked environment.
@@ -42,12 +42,12 @@ class WiFiServer : public Server {
 
 public:
   /**
-   * @brief Initializes objects of the `WiFiServer` class.
+   * @brief Initializes objects of the WiFiServer class.
    */
   WiFiServer();
 
   /**
-   * @brief Constructs a `WiFiServer` object with the specified port.
+   * @brief Constructs a WiFiServer object with the specified port.
    * 
    * @param `p` The port number on which the server will listen for incoming connections.
    */
@@ -61,15 +61,15 @@ class WiFiServer : public Server {
    * the client. It uses the modem to query the server for an available client 
    * socket and accepts the connection if a valid client is found.
    *
-   * @return Returns a `WiFiClient` object representing the next client connection that is available
+   * @return Returns a WiFiClient object representing the next client connection that is available
    * for processing.
    */
   WiFiClient available();
 
   /**
    * @brief Accepts an incoming client connection on the server.
    * 
-   * @return Returns a `WiFiClient` object representing the accepted client.
+   * @return Returns a WiFiClient object representing the accepted client.
    */
   WiFiClient accept();
 
@@ -120,9 +120,9 @@ class WiFiServer : public Server {
   void end();
 
   /**
-   * @brief Converts the `WiFiSSLClient` object to a boolean value.
+   * @brief Converts the WiFiSSLClient object to a boolean value.
    * 
-   * This operator allows a `WiFiSSLClient` object to be implicitly or explicitly
+   * This operator allows a WiFiSSLClient object to be implicitly or explicitly
    * converted to a boolean. It checks whether the client socket is valid (i.e., 
    * `_sock != -1`).
    * 
@@ -131,20 +131,21 @@ class WiFiServer : public Server {
   explicit operator bool();
 
   /**
-   * @brief Compares two `WiFiServer` objects for equality.
+   * @brief Compares two WiFiServer objects for equality.
    * 
    * This virtual operator compares the underlying socket (`_sock`) of two `WiFiServer` 
    * objects to determine if they refer to the same server connection.
    * 
-   * @param `WiFiServer` object to compare against.
-   * @return `true` if both `WiFiServer` objects have the same socket; `false` otherwise.
+   * @param WiFiServer object to compare against.
+   * 
+   * @return `true` if both WiFiServer objects have the same socket; `false` otherwise.
    */
   virtual bool operator==(const WiFiServer&);
 
   /**
-   * @brief Compares two `WiFiServer` objects for inequality.
+   * @brief Compares two WiFiServer objects for inequality.
    * 
-   * This virtual operator compares the underlying socket (`_sock`) of two `WiFiServer` 
+   * This virtual operator compares the underlying socket (`_sock`) of two WiFiServer
    * objects. It returns `true` if the objects do not refer to the same server connection 
    * (i.e., they have different socket values), and `false` otherwise.
    * 
@@ -159,13 +160,13 @@ class WiFiServer : public Server {
   /**
    * @brief Inherits the `write` method from the `Print` class.
    * 
-   * This allows the `WiFiSSLClient` class to use the `write` method defined in the 
+   * This allows the WiFiSSLClient class to use the `write` method defined in the 
    * `Print` class.
    */
   using Print::write;
 
   /**
-   * @brief Grants `WiFiClient` class access to private and protected members of `WiFiServer`.
+   * @brief Grants WiFiClient class access to private and protected members of WiFiServer.
    */
   friend class WiFiClient;
 };

libraries/WiFiS3/src/WiFiUdp.h

@@ -33,7 +33,7 @@
 /**
  * @brief A class for handling UDP communication over a Wi-Fi network.
  * 
- * The `WiFiUDP` class is an extension of the `UDP` class that enables sending and receiving UDP packets
+ * The WiFiUDP class is an extension of the UDP class that enables sending and receiving UDP packets
  * over a Wi-Fi network. It provides functions for initialization, packet transmission, and reception
  * tailored for Wi-Fi connectivity.
  */
@@ -150,9 +150,9 @@ class WiFiUDP : public UDP {
   virtual size_t write(const uint8_t *buffer, size_t size);
 
   /**
-   * @brief Inherits the `write` method from the `Print` class.
+   * @brief Inherits the `write` method from the Print class.
    * 
-   * This allows the `WiFiSSLClient` class to use the `write` method defined in the 
+   * This allows the WiFiSSLClient class to use the `write` method defined in the 
    * `Print` class.
    */
   using Print::write;