Skip to content

Commit 96df3e6

Browse files
Updated API docs
1 parent 38d6751 commit 96df3e6

File tree

2 files changed

+9
-15
lines changed

2 files changed

+9
-15
lines changed

libraries/WiFiS3/src/Modem.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,18 @@ class ModemClass {
1919

2020
public:
2121
/**
22+
* @brief Constructor for the ModemClass, which initializes the modem with the specified transmit (TX) and receive (RX) pins.
23+
*
2224
* @param Initializes an instance of the `ModemClass` class with
23-
* specific transmit (tx) and receive (rx) pins for communication.
25+
* specific transmit `tx` and receive `rx` pins for communication.
2426
*/
2527
ModemClass(int tx, int rx);
28+
29+
/**
30+
* @brief Constructor for the ModemClass, which initializes the modem with the specified UART interface.
31+
*
32+
* @param `_serial` is a pointer to the UART object that will be used for communication with the modem.
33+
*/
2634
ModemClass(UART * _serial);
2735
~ModemClass();
2836

libraries/WiFiS3/src/WiFiClient.h

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,20 +54,6 @@ class WiFiClient : public Client {
5454
WiFiClient(const WiFiClient& c);
5555
~WiFiClient();
5656

57-
58-
/**
59-
* @brief Establishes a connection to a server using an IP address and port.
60-
*
61-
* This function initiates a connection to a server using the specified IP address
62-
* and port. Internally, it converts the IP address to a string and delegates
63-
* the connection task to the `connect(const char*, uint16_t)` method.
64-
*
65-
* @param ip The IP address of the server to connect to.
66-
* @param port The port number on the server to connect to.
67-
*
68-
* @return `1` on a successful connection, `0` on failure.
69-
*/
70-
7157
/**
7258
* @brief Establishes a connection to a server using an IP address and port.
7359
*

0 commit comments

Comments
 (0)