Skip to content

Commit 85e6ead

Browse files
Update ArduinoCellular.h
Fixed doxygen style comments on the overloaded connect method without username and password.
1 parent a97dec0 commit 85e6ead

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/ArduinoCellular.h

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,12 @@ class ArduinoCellular {
124124
*/
125125
bool connect(String apn = "", String username = "", String password = "", bool waitForever = true);
126126

127-
/**
128-
* @brief same as previous, username and password are empty
127+
/**
128+
* @brief Registers with the cellular network and connects to the Internet
129+
* if the APN, GPRS username, and GPRS password are provided.
130+
* @param apn The Access Point Name.
131+
* @param waitForever The function does not return unless a connection has been established
132+
* @return True if the connection is successful, false otherwise.
129133
*/
130134
bool connect(String apn, bool waitForever = true);
131135

0 commit comments

Comments
 (0)