Skip to content

Commit a382728

Browse files
Fixed formatting
1 parent 1399224 commit a382728

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

libraries/WiFiS3/docs/api.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ It inherits from the Client class, providing basic socket communication function
4141
| [`stop`](#class_wi_fi_client_1acb61f8e0ecd50e40ce6cbcb7106ce1b1) | Closes the connection to the server and clears the receive buffer. |
4242
| [`connected`](#class_wi_fi_client_1af083fe27b94aebec37f140c0b973f974) | Checks if the client is connected to a server. |
4343
| [`operator bool`](#class_wi_fi_client_1adaf93736006b5bb2426e9816de4207eb) | Implicit conversion operator to `bool`. |
44-
| [`operator==`](#class_wi_fi_client_1ac1e068fb2468d84536e93f6e1b51b099) | Equality operator for comparing two `[WiFiClient](#class_wi_fi_client)` objects. |
45-
| [`operator!=`](#class_wi_fi_client_1a31b6e43ab5ab9d6fe511778a5a1f173c) | Inequality operator for comparing two `[WiFiClient](#class_wi_fi_client)` objects. |
44+
| [`operator==`](#class_wi_fi_client_1ac1e068fb2468d84536e93f6e1b51b099) | Equality operator for comparing two [WiFiClient](#class_wi_fi_client) objects. |
45+
| [`operator!=`](#class_wi_fi_client_1a31b6e43ab5ab9d6fe511778a5a1f173c) | Inequality operator for comparing two [WiFiClient](#class_wi_fi_client) objects. |
4646
| [`remoteIP`](#class_wi_fi_client_1a46d45c8d326b62256f85d55eaa337df0) | Retrieves the remote IP address of the server the client is connected to. |
4747
| [`remotePort`](#class_wi_fi_client_1a38ca1399ebf6570d2c852c9062ec92d8) | Retrieves the remote port number of the server the client is connected to. |
4848
| [`setConnectionTimeout`](#class_wi_fi_client_1af32938f36f09c9121e85e38338d432d7) | Sets the connection timeout for the client. |
@@ -80,7 +80,7 @@ WiFiClient(const WiFiClient & c)
8080
Copy constructor for the [WiFiClient](#class_wi_fi_client) class.
8181

8282
#### Parameters
83-
* `c` is the `[WiFiClient](#class_wi_fi_client)` object to copy.
83+
* `c` is the [WiFiClient](#class_wi_fi_client) object to copy.
8484
<hr />
8585

8686
### `~WiFiClient` <a id="class_wi_fi_client_1a6410fb12d526d541c436136b18faa0db" class="anchor"></a>
@@ -253,7 +253,7 @@ inline virtual operator bool()
253253

254254
Implicit conversion operator to `bool`.
255255

256-
Converts the `[WiFiClient](#class_wi_fi_client)` object to a `bool` value indicating whether the client is connected or not.
256+
Converts the [WiFiClient](#class_wi_fi_client) object to a `bool` value indicating whether the client is connected or not.
257257

258258
#### Returns
259259
`true` if the client socket is open and valid, `false` otherwise.
@@ -265,15 +265,15 @@ Converts the `[WiFiClient](#class_wi_fi_client)` object to a `bool` value indica
265265
virtual bool operator==(const WiFiClient &)
266266
```
267267

268-
Equality operator for comparing two `[WiFiClient](#class_wi_fi_client)` objects.
268+
Equality operator for comparing two [WiFiClient](#class_wi_fi_client) objects.
269269

270-
Compares the current `[WiFiClient](#class_wi_fi_client)` object with another `[WiFiClient](#class_wi_fi_client)` object to determine if they represent the same socket connection.
270+
Compares the current [WiFiClient](#class_wi_fi_client) object with another [WiFiClient](#class_wi_fi_client) object to determine if they represent the same socket connection.
271271

272272
#### Parameters
273-
* `The` `[WiFiClient](#class_wi_fi_client)` object to compare with.
273+
* `The` [WiFiClient](#class_wi_fi_client) object to compare with.
274274

275275
#### Returns
276-
`true` if both `[WiFiClient](#class_wi_fi_client)` objects represent the same socket, `false` otherwise.
276+
`true` if both [WiFiClient](#class_wi_fi_client) objects represent the same socket, `false` otherwise.
277277
<hr />
278278

279279
### `operator!=` <a id="class_wi_fi_client_1a31b6e43ab5ab9d6fe511778a5a1f173c" class="anchor"></a>
@@ -282,12 +282,12 @@ Compares the current `[WiFiClient](#class_wi_fi_client)` object with another `[W
282282
inline virtual bool operator!=(const WiFiClient & whs)
283283
```
284284

285-
Inequality operator for comparing two `[WiFiClient](#class_wi_fi_client)` objects.
285+
Inequality operator for comparing two [WiFiClient](#class_wi_fi_client) objects.
286286

287-
Compares the current `[WiFiClient](#class_wi_fi_client)` object with another `[WiFiClient](#class_wi_fi_client)` object to determine if they represent different socket connections.
287+
Compares the current [WiFiClient](#class_wi_fi_client) object with another [WiFiClient](#class_wi_fi_client) object to determine if they represent different socket connections.
288288

289289
#### Parameters
290-
* `whs` is the `[WiFiClient](#class_wi_fi_client)` object to compare with.
290+
* `whs` is the [WiFiClient](#class_wi_fi_client) object to compare with.
291291

292292
#### Returns
293293
`true` if both [WiFiClient](#class_wi_fi_client) objects represent different sockets, `false` if they represent the same socket.
@@ -457,7 +457,7 @@ WiFiClient available()
457457

458458
Checks if there are any incoming client connections waiting to be accepted.
459459

460-
This function queries the server to check if there is a client waiting to be accepted. If a client is available, it returns a `[WiFiClient](#class_wi_fi_client)` object representing 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.
460+
This function queries the server to check if there is a client waiting to be accepted. If a client is available, it returns a [WiFiClient](#class_wi_fi_client) object representing 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.
461461

462462
#### Returns
463463
Returns a [WiFiClient](#class_wi_fi_client) object representing the next client connection that is available for processing.
@@ -560,10 +560,10 @@ virtual bool operator==(const WiFiServer &)
560560

561561
Compares two [WiFiServer](#class_wi_fi_server) objects for equality.
562562

563-
This virtual operator compares the underlying socket (`_sock`) of two `[WiFiServer](#class_wi_fi_server)` objects to determine if they refer to the same server connection.
563+
This virtual operator compares the underlying socket (`_sock`) of two [WiFiServer](#class_wi_fi_server) objects to determine if they refer to the same server connection.
564564

565565
#### Parameters
566-
* `[WiFiServer](#class_wi_fi_server)` object to compare against.
566+
* [WiFiServer](#class_wi_fi_server) object to compare against.
567567

568568
#### Returns
569569
`true` if both [WiFiServer](#class_wi_fi_server) objects have the same socket; `false` otherwise.
@@ -617,8 +617,8 @@ The [WiFiSSLClient](#class_wi_fi_s_s_l_client) class extends the functionality o
617617
| [`stop`](#class_wi_fi_s_s_l_client_1a66113af6fbc85f0dbb73f8d276b8a77a) | Terminates the SSL/TLS connection and clears the receive buffer. |
618618
| [`connected`](#class_wi_fi_s_s_l_client_1a5e993c746855bb67c744d27baa6cf1bb) | Checks if the SSL/TLS connection is active. |
619619
| [`operator bool`](#class_wi_fi_s_s_l_client_1a46888795cc1562c33fad408b57d2ad40) | Implicit conversion operator to check if the SSL client is connected. |
620-
| [`operator==`](#class_wi_fi_s_s_l_client_1aa0bdf11dd3e6ef48133967dc0a036004) | Comparison operator to check equality between two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` objects. |
621-
| [`operator!=`](#class_wi_fi_s_s_l_client_1a2cdd8020168fae9e08d3c6d00b30b065) | Inequality operator to compare two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` objects. |
620+
| [`operator==`](#class_wi_fi_s_s_l_client_1aa0bdf11dd3e6ef48133967dc0a036004) | Comparison operator to check equality between two [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects. |
621+
| [`operator!=`](#class_wi_fi_s_s_l_client_1a2cdd8020168fae9e08d3c6d00b30b065) | Inequality operator to compare two [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects. |
622622
| [`remoteIP`](#class_wi_fi_s_s_l_client_1acff0aa8078124dff0c0ff3bfee7cfd83) | Retrieves the remote IP address of the WiFi SSL client. |
623623
| [`remotePort`](#class_wi_fi_s_s_l_client_1aea76ab94b3cdfec17ab6e73c7b169da7) | Retrieves the remote port number of the WiFi SSL client. |
624624
@@ -838,7 +838,7 @@ Implicit conversion operator to check if the SSL client is connected.
838838
virtual bool operator==(const WiFiSSLClient &)
839839
```
840840

841-
Comparison operator to check equality between two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` objects.
841+
Comparison operator to check equality between two [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects.
842842

843843
#### Parameters
844844
* `WiFiSSLClient` object to compare.
@@ -853,9 +853,9 @@ Comparison operator to check equality between two `[WiFiSSLClient](#class_wi_fi_
853853
inline virtual bool operator!=(const WiFiSSLClient & whs)
854854
```
855855

856-
Inequality operator to compare two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` objects.
856+
Inequality operator to compare two [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects.
857857

858-
This operator compares the current `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` object with another `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` object to determine if they are not equal, based on their underlying socket or connection.
858+
This operator compares the current [WiFiSSLClient](#class_wi_fi_s_s_l_client) object with another [WiFiSSLClient](#class_wi_fi_s_s_l_client) object to determine if they are not equal, based on their underlying socket or connection.
859859

860860
#### Parameters
861861
* `whs` The [WiFiSSLClient](#class_wi_fi_s_s_l_client) object to compare with.
@@ -1191,7 +1191,7 @@ virtual bool operator==(const WiFiUDP &)
11911191

11921192
Compares two [WiFiUDP](#class_wi_fi_u_d_p) objects for equality.
11931193

1194-
This function compares two `[WiFiUDP](#class_wi_fi_u_d_p)` objects by checking if their associated socket values (`_sock`) are the same.
1194+
This function compares two [WiFiUDP](#class_wi_fi_u_d_p) objects by checking if their associated socket values (`_sock`) are the same.
11951195

11961196
#### Parameters
11971197
* `WiFiUDP&` The [WiFiUDP](#class_wi_fi_u_d_p) object to compare with the current object.
@@ -1208,7 +1208,7 @@ inline virtual bool operator!=(const WiFiUDP & whs)
12081208

12091209
Compares two [WiFiUDP](#class_wi_fi_u_d_p) objects for inequality.
12101210

1211-
This function compares two `[WiFiUDP](#class_wi_fi_u_d_p)` objects by checking if their associated socket values (`_sock`) are different.
1211+
This function compares two [WiFiUDP](#class_wi_fi_u_d_p) objects by checking if their associated socket values (`_sock`) are different.
12121212

12131213
#### Parameters
12141214
* `whs` The [WiFiUDP](#class_wi_fi_u_d_p) object to compare with the current object.
@@ -1226,7 +1226,7 @@ virtual IPAddress remoteIP()
12261226
Retrieves the remote IP address of the host who sent the current incoming packet.
12271227

12281228
#### Returns
1229-
An `IPAddress` object representing the remote IP address. If the socket is not valid or the address cannot be retrieved, it returns `IPAddress(0, 0, 0, 0)`.
1229+
An `IPAddress` object representing the remote IP address. If the socket is not valid or the address cannot be retrieved, it returns `IPAddress(0, 0, 0, 0).
12301230
<hr />
12311231

12321232
### `remotePort` <a id="class_wi_fi_u_d_p_1a2ebb4b0e8fc1c4c147bd5936ff7ab250" class="anchor"></a>

0 commit comments

Comments
 (0)