Skip to content

Commit 1399224

Browse files
Removed unused tags
1 parent 20a2010 commit 1399224

File tree

1 file changed

+47
-47
lines changed

1 file changed

+47
-47
lines changed

libraries/WiFiS3/docs/api.md

+47-47
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ WiFiClient(int s)
6868
Constructor to initialize a [WiFiClient](#class_wi_fi_client) object with a specific socket.
6969
7070
#### Parameters
71-
* `<tt>s</tt>` is the socket descriptor to associate with this client.
71+
* `s` is the socket descriptor to associate with this client.
7272
<hr />
7373
7474
### `WiFiClient` <a id="class_wi_fi_client_1a1b176d034c1239bdcffa6db13ef5e485" class="anchor"></a>
@@ -80,7 +80,7 @@ WiFiClient(const WiFiClient & c)
8080
Copy constructor for the [WiFiClient](#class_wi_fi_client) class.
8181

8282
#### Parameters
83-
* `<tt>c</tt>` 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>
@@ -102,9 +102,9 @@ virtual int connect(IPAddress ip, uint16_t port)
102102
Establishes a connection to a server using an IP address and port.
103103
104104
#### Parameters
105-
* `<tt>ip</tt>` as the IP address of the server to connect to.
105+
* `ip` as the IP address of the server to connect to.
106106
107-
* `<tt>port</tt>` as the port number on the server to connect to.
107+
* `port` as the port number on the server to connect to.
108108
109109
#### Returns
110110
`1` on a successful connection, `0` on failure.
@@ -119,9 +119,9 @@ virtual int connect(const char * host, uint16_t port)
119119
Establishes a connection to a server using a hostname and port.
120120

121121
#### Parameters
122-
* `<tt>host</tt>` is a pointer to a null-terminated string containing the hostname of the server.
122+
* `host` is a pointer to a null-terminated string containing the hostname of the server.
123123

124-
* `<tt>port</tt>` is the port number on the server to connect to.
124+
* `port` is the port number on the server to connect to.
125125

126126
#### Returns
127127
`1` if the connection was successful, `0` otherwise.
@@ -136,7 +136,7 @@ virtual size_t write(uint8_t)
136136
Sends a single byte of data to the connected server.
137137
138138
#### Parameters
139-
* `<tt>b</tt>` being the byte of data to send.
139+
* `b` being the byte of data to send.
140140
141141
#### Returns
142142
The number of bytes successfully written, which is `1` on success or `0` on failure.
@@ -192,9 +192,9 @@ Reads multiple bytes of data from the server into a buffer.
192192
This function retrieves data from the server's receive buffer and stores it into the provided array. It attempts to read up to the specified number of bytes (`size`).
193193
194194
#### Parameters
195-
* `<tt>buf</tt>` is a pointer to the buffer where the data will be stored.
195+
* `buf` is a pointer to the buffer where the data will be stored.
196196
197-
* `<tt>size</tt>` is the maximum number of bytes to read.
197+
* `size` is the maximum number of bytes to read.
198198
199199
#### Returns
200200
The number of bytes successfully read into the buffer. Returns `0` if no data is available or if the socket is invalid.
@@ -287,7 +287,7 @@ Inequality operator for comparing two `[WiFiClient](#class_wi_fi_client)` object
287287
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-
* `<tt>whs</tt>` 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.
@@ -326,7 +326,7 @@ inline void setConnectionTimeout(int timeout)
326326
Sets the connection timeout for the client.
327327
328328
#### Parameters
329-
* `<tt>timeout</tt>` is the timeout value in milliseconds.
329+
* `timeout` is the timeout value in milliseconds.
330330
<hr />
331331
332332
# class `WiFiFileSystem` <a id="class_wi_fi_file_system" class="anchor"></a>
@@ -377,7 +377,7 @@ size_t writefile(const char * name, const char * data, size_t size, int operatio
377377
Writes data to a file in the file system.
378378

379379
#### Parameters
380-
* `<tt>name</tt>` is the name of the file to which the data will be written. A pointer `data` to the data that will be written to the file. `size` is the number of bytes to write from the provided data buffer. `operation` determines the type of file operation to perform (e.g., create, overwrite).
380+
* `name` is the name of the file to which the data will be written. A pointer `data` to the data that will be written to the file. `size` is the number of bytes to write from the provided data buffer. `operation` determines the type of file operation to perform (e.g., create, overwrite).
381381

382382
#### Returns
383383
Returns the number of bytes successfully written. Returns 0 if the operation fails.
@@ -394,7 +394,7 @@ Reads a file from the file system and prints its content.
394394
It sends the read request to the modem, which fetches the data. The content is printed to the serial output in chunks, with each chunk being processed until the entire file is read.
395395
396396
#### Parameters
397-
* `<tt>name</tt>` is the name of the file to be read from the file system.
397+
* `name` is the name of the file to be read from the file system.
398398
<hr />
399399
400400
# class `WiFiServer` <a id="class_wi_fi_server" class="anchor"></a>
@@ -446,7 +446,7 @@ WiFiServer(int p)
446446
Constructs a [WiFiServer](#class_wi_fi_server) object with the specified port.
447447
448448
#### Parameters
449-
* `<tt>p</tt>` The port number on which the server will listen for incoming connections.
449+
* `p` The port number on which the server will listen for incoming connections.
450450
<hr />
451451
452452
### `available` <a id="class_wi_fi_server_1abfd839b75fa3c40bd5e22c4a122ed800" class="anchor"></a>
@@ -484,7 +484,7 @@ void begin(int port)
484484
Starts the Wi-Fi server and binds it to the specified port.
485485
486486
#### Parameters
487-
* `<tt>port</tt>` is the port number which the server will listen to for incoming connections.
487+
* `port` is the port number which the server will listen to for incoming connections.
488488
<hr />
489489
490490
### `begin` <a id="class_wi_fi_server_1a953b3d2a3ea0b0582be9535b6aa908d9" class="anchor"></a>
@@ -507,7 +507,7 @@ virtual size_t write(uint8_t)
507507
Writes a single byte to all connected clients.
508508
509509
#### Parameters
510-
* `<tt>b</tt>` is the byte to be sent to the clients.
510+
* `b` is the byte to be sent to the clients.
511511
<hr />
512512
513513
### `write` <a id="class_wi_fi_server_1a6bef9499519bcedd59379024c4e7b360" class="anchor"></a>
@@ -521,7 +521,7 @@ Writes data to all connected clients.
521521
This function sends a buffer of data to all clients connected to the server. It writes the specified number of bytes to the server socket and returns the count of successfully written bytes.
522522

523523
#### Parameters
524-
* `<tt>buf</tt>` is a pointer to the buffer containing the data to be sent. `size` is the number of bytes to write from the buffer.
524+
* `buf` is a pointer to the buffer containing the data to be sent. `size` is the number of bytes to write from the buffer.
525525

526526
#### Returns
527527
The number of bytes successfully written. Returns 0 if the data could not be sent.
@@ -580,7 +580,7 @@ Compares two [WiFiServer](#class_wi_fi_server) objects for inequality.
580580
This virtual operator compares the underlying socket (`_sock`) of two [WiFiServer](#class_wi_fi_server) 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.
581581

582582
#### Parameters
583-
* `<tt>whs</tt>` The [WiFiServer](#class_wi_fi_server) object to compare against.
583+
* `whs` The [WiFiServer](#class_wi_fi_server) object to compare against.
584584

585585
#### Returns
586586
`true` if the [WiFiServer](#class_wi_fi_server) objects have different sockets; `false` otherwise.
@@ -666,7 +666,7 @@ virtual int connect(const char * host, uint16_t port)
666666
Establishes a secure SSL connection to a specified host and port.
667667

668668
#### Parameters
669-
* `<tt>host</tt>` is the hostname or IP address of the server to connect to. `port` is the port number to connect to.
669+
* `host` is the hostname or IP address of the server to connect to. `port` is the port number to connect to.
670670

671671
#### Returns
672672
Returns `1` if the connection is successfully established, `0` otherwise.
@@ -681,7 +681,7 @@ void setCACert(const char * root_ca)
681681
Sets the Certificate Authority (CA) for SSL/TLS verification.
682682
683683
#### Parameters
684-
* `<tt>root_ca</tt>` is a pointer to a null-terminated string containing the root CA certificate in PEM format. If set to `nullptr`, the default root CA bundle will be used.
684+
* `root_ca` is a pointer to a null-terminated string containing the root CA certificate in PEM format. If set to `nullptr`, the default root CA bundle will be used.
685685
<hr />
686686
687687
### `setEccSlot` <a id="class_wi_fi_s_s_l_client_1a9720117b29a35bc2a43c133f76fd8f8e" class="anchor"></a>
@@ -693,11 +693,11 @@ void setEccSlot(int ecc508KeySlot, const byte cert, int certLength)
693693
Sets the ECC (Elliptic Curve Cryptography) key slot and certificate for establishing secure SSL connections.
694694

695695
#### Parameters
696-
* `<tt>int` ecc508KeySlot specifies the ECC key slot to be used for the SSL connection.
696+
* `int` ecc508KeySlot specifies the ECC key slot to be used for the SSL connection.
697697

698-
* `<tt>const` byte cert[] is a pointer to the certificate data in the form of an array of bytes.
698+
* `const` byte cert[] is a pointer to the certificate data in the form of an array of bytes.
699699

700-
* `<tt>int` certLength specifies the length of the certificate data array.
700+
* `int` certLength specifies the length of the certificate data array.
701701
<hr />
702702

703703
### `write` <a id="class_wi_fi_s_s_l_client_1aa998458d525200ce36277d637008f87c" class="anchor"></a>
@@ -709,7 +709,7 @@ virtual size_t write(uint8_t)
709709
Writes a single byte of data to the SSL connection.
710710
711711
#### Parameters
712-
* `<tt>b</tt>` is the byte to be sent.
712+
* `b` is the byte to be sent.
713713
714714
#### Returns
715715
The number of bytes successfully written. Returns `1` if the byte was sent successfully, or `0` if an error occurred.
@@ -724,9 +724,9 @@ virtual size_t write(const uint8_t * buf, size_t size)
724724
Writes a buffer of data to the SSL connection.
725725

726726
#### Parameters
727-
* `<tt>buf</tt>` is a pointer to the buffer containing the data to be sent.
727+
* `buf` is a pointer to the buffer containing the data to be sent.
728728

729-
* `<tt>size</tt>` is the number of bytes to send from the buffer.
729+
* `size` is the number of bytes to send from the buffer.
730730

731731
#### Returns
732732
Returns `size` if the data is successfully sent, or `0` if the transmission fails or the socket is invalid.
@@ -765,7 +765,7 @@ virtual int read(uint8_t * buf, size_t size)
765765
Reads a specified number of bytes from the SSL connection into a buffer.
766766
767767
#### Parameters
768-
* `<tt>buf</tt>` 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.
768+
* `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.
769769
770770
#### Returns
771771
The number of bytes successfully read. Returns `0` if no data is available or an error occurs.
@@ -841,7 +841,7 @@ virtual bool operator==(const WiFiSSLClient &)
841841
Comparison operator to check equality between two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)` objects.
842842

843843
#### Parameters
844-
* `<tt>WiFiSSLClient</tt>` object to compare.
844+
* `WiFiSSLClient` object to compare.
845845

846846
#### Returns
847847
`true` if both [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects are equivalent (i.e., they have the same socket), `false` otherwise.
@@ -858,7 +858,7 @@ Inequality operator to compare two `[WiFiSSLClient](#class_wi_fi_s_s_l_client)`
858858
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
861-
* `<tt>whs</tt>` The [WiFiSSLClient](#class_wi_fi_s_s_l_client) object to compare with.
861+
* `whs` The [WiFiSSLClient](#class_wi_fi_s_s_l_client) object to compare with.
862862

863863
#### Returns
864864
`true` if the two [WiFiSSLClient](#class_wi_fi_s_s_l_client) objects do not represent the same connection (i.e., have different sockets), `false` otherwise.
@@ -951,7 +951,7 @@ virtual uint8_t begin(uint16_t)
951951
Starts a UDP socket on the specified local port.
952952
953953
#### Parameters
954-
* `<tt>uint16_t</tt>` The local port number to bind the UDP socket to.
954+
* `uint16_t` The local port number to bind the UDP socket to.
955955
956956
#### Returns
957957
Returns `1` if the socket is successfully opened, or `0` if the socket is already in use or could not be opened.
@@ -966,9 +966,9 @@ virtual uint8_t begin(IPAddress a, uint16_t p)
966966
Starts a UDP socket bound to a specific IP address and port.
967967

968968
#### Parameters
969-
* `<tt>a</tt>` The local IP address to bind the UDP socket to.
969+
* `a` The local IP address to bind the UDP socket to.
970970

971-
* `<tt>p</tt>` The local port number to bind the UDP socket to.
971+
* `p` The local port number to bind the UDP socket to.
972972

973973
#### Returns
974974
Returns `1` if the socket is successfully opened, or `0` if the socket is already in use or could not be opened.
@@ -983,9 +983,9 @@ virtual uint8_t beginMulticast(IPAddress, uint16_t)
983983
Starts a UDP multicast socket bound to a specific IP address and port.
984984
985985
#### Parameters
986-
* `<tt>IPAddress</tt>` The multicast IP address to bind the UDP socket to.
986+
* `IPAddress` The multicast IP address to bind the UDP socket to.
987987
988-
* `<tt>uint16_t</tt>` The port number to bind the UDP socket to.
988+
* `uint16_t` The port number to bind the UDP socket to.
989989
990990
#### Returns
991991
Returns `1` if the socket is successfully opened, or `0` if the socket is already in use or could not be opened.
@@ -1022,9 +1022,9 @@ virtual int beginPacket(IPAddress ip, uint16_t port)
10221022
Begins constructing a UDP packet for sending to a specific IP address and port.
10231023
10241024
#### Parameters
1025-
* `<tt>ip</tt>` The destination IP address as an `IPAddress` object.
1025+
* `ip` The destination IP address as an `IPAddress` object.
10261026
1027-
* `<tt>port</tt>` The destination port number.
1027+
* `port` The destination port number.
10281028
10291029
#### Returns
10301030
Returns `1` if the packet preparation is successful. Or `0` if there is an error or the socket is not initialized.
@@ -1039,9 +1039,9 @@ virtual int beginPacket(const char * host, uint16_t port)
10391039
Begins constructing a UDP packet for sending to a specific hostname and port.
10401040

10411041
#### Parameters
1042-
* `<tt>host</tt>` The destination hostname as a null-terminated string.
1042+
* `host` The destination hostname as a null-terminated string.
10431043

1044-
* `<tt>port</tt>` The destination port number.
1044+
* `port` The destination port number.
10451045

10461046
#### Returns
10471047
Returns `1` if the packet preparation is successful. Or `0` if there is an error or the socket is not initialized.
@@ -1068,7 +1068,7 @@ virtual size_t write(uint8_t)
10681068
Sends a single byte of data to the currently opened UDP packet.
10691069
10701070
#### Parameters
1071-
* `<tt>b</tt>` The byte of data to send.
1071+
* `b` The byte of data to send.
10721072
10731073
#### Returns
10741074
Returns `1` if the byte was successfully written. Or `0` if there was an error or the packet was not properly initialized.
@@ -1083,9 +1083,9 @@ virtual size_t write(const uint8_t * buffer, size_t size)
10831083
Sends a buffer of data to the currently opened UDP packet.
10841084

10851085
#### Parameters
1086-
* `<tt>buffer</tt>` A pointer to the buffer containing the data to send.
1086+
* `buffer` A pointer to the buffer containing the data to send.
10871087

1088-
* `<tt>size</tt>` The number of bytes from the buffer to write.
1088+
* `size` The number of bytes from the buffer to write.
10891089

10901090
#### Returns
10911091
Returns the number of bytes successfully written if the operation is successful. Or `0` if the data was not successfully written, or if the packet was not properly initialized.
@@ -1136,9 +1136,9 @@ virtual int read(unsigned char * buffer, size_t len)
11361136
Reads data from the UDP receive buffer into a provided buffer.
11371137
11381138
#### Parameters
1139-
* `<tt>buffer</tt>` A pointer to the buffer where the received data will be stored.
1139+
* `buffer` A pointer to the buffer where the received data will be stored.
11401140
1141-
* `<tt>size</tt>` The number of bytes to read from the UDP buffer.
1141+
* `size` The number of bytes to read from the UDP buffer.
11421142
11431143
#### Returns
11441144
The number of bytes successfully read into the buffer. If less than `size` bytes are read, it indicates that the buffer was exhausted early.
@@ -1153,9 +1153,9 @@ inline virtual int read(char * buffer, size_t len)
11531153
Reads data from the UDP receive buffer into a character buffer.
11541154

11551155
#### Parameters
1156-
* `<tt>buffer</tt>` A pointer to the character buffer where the received data will be stored.
1156+
* `buffer` A pointer to the character buffer where the received data will be stored.
11571157

1158-
* `<tt>len</tt>` The number of bytes to read from the UDP buffer.
1158+
* `len` The number of bytes to read from the UDP buffer.
11591159

11601160
#### Returns
11611161
The number of bytes successfully read into the buffer. If less than `len` bytes are read, it indicates that the buffer was exhausted early.
@@ -1194,7 +1194,7 @@ Compares two [WiFiUDP](#class_wi_fi_u_d_p) objects for equality.
11941194
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
1197-
* `<tt>WiFiUDP&</tt>` The [WiFiUDP](#class_wi_fi_u_d_p) object to compare with the current object.
1197+
* `WiFiUDP&` The [WiFiUDP](#class_wi_fi_u_d_p) object to compare with the current object.
11981198

11991199
#### Returns
12001200
`true` if the socket values are equal, `false` otherwise.
@@ -1211,7 +1211,7 @@ Compares two [WiFiUDP](#class_wi_fi_u_d_p) objects for inequality.
12111211
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
1214-
* `<tt>whs</tt>` The [WiFiUDP](#class_wi_fi_u_d_p) object to compare with the current object.
1214+
* `whs` The [WiFiUDP](#class_wi_fi_u_d_p) object to compare with the current object.
12151215

12161216
#### Returns
12171217
`true` if the socket values are different, `false` otherwise.

0 commit comments

Comments
 (0)