Updated API

BenjaminDannegard · BenjaminDannegard · commit 003c19d22e05 · 2024-11-27T09:44:40.000+01:00
diff --git a/libraries/WiFiS3/src/WiFiClient.h b/libraries/WiFiS3/src/WiFiClient.h
@@ -57,8 +57,8 @@ class WiFiClient : public Client {
   /**
    * @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.
+   * @param `ip` as the IP address of the server to connect to.
+   * @param `port` as the port number on the server to connect to.
    * 
    * @return `1` on a successful connection, `0` on failure.
    */
@@ -68,7 +68,7 @@ class WiFiClient : public Client {
    * @brief Establishes a connection to a server using a hostname and port.
    * 
    * @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.
+   * @param `port` is the port number on the server to connect to.
    * 
    * @return `1` if the connection was successful, `0` otherwise.
    */

Original file line number	Diff line number	Diff line change
`@@ -57,8 +57,8 @@ class WiFiClient : public Client {`
`57`	`57`	`/**`
`58`	`58`	`* @brief Establishes a connection to a server using an IP address and port.`
`59`	`59`	`*`
`60`		- * @param Using `ip` as the IP address of the server to connect to.
`61`		- * And `port` as the port number on the server to connect to.
	`60`	+ * @param `ip` as the IP address of the server to connect to.
	`61`	+ * @param `port` as the port number on the server to connect to.
`62`	`62`	`*`
`63`	`63`	* @return `1` on a successful connection, `0` on failure.
`64`	`64`	`*/`
`@@ -68,7 +68,7 @@ class WiFiClient : public Client {`
`68`	`68`	`* @brief Establishes a connection to a server using a hostname and port.`
`69`	`69`	`*`
`70`	`70`	* @param `host` is a pointer to a null-terminated string containing the hostname of the server.
`71`		- * And `port` is the port number on the server to connect to.
	`71`	+ * @param `port` is the port number on the server to connect to.
`72`	`72`	`*`
`73`	`73`	* @return `1` if the connection was successful, `0` otherwise.
`74`	`74`	`*/`