Skip to content

Commit b0b22fa

Browse files
Mel WCruz Monrreal II
authored andcommitted
Capitalization, formatting of true and false, punctuation.
1 parent 2be0af7 commit b0b22fa

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

features/netsocket/CellularBase.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ class CellularBase: public NetworkInterface {
4545
virtual void set_credentials(const char *apn, const char *uname = 0,
4646
const char *pwd = 0) = 0;
4747

48-
/** Set the pin code for SIM card.
48+
/** Set the PIN code for SIM card.
4949
*
5050
* @param sim_pin PIN for the SIM card.
5151
*/
5252
virtual void set_sim_pin(const char *sim_pin) = 0;
5353

54-
/** Attempt to connect to a cellular network with a pin and credentials.
54+
/** Attempt to connect to a cellular network with a PIN and credentials.
5555
*
5656
* @param sim_pin PIN for the SIM card.
5757
* @param apn Access point name (optional).
@@ -65,7 +65,7 @@ class CellularBase: public NetworkInterface {
6565

6666
/** Attempt to connect to a cellular network.
6767
*
68-
* If the SIM requires a PIN, and it is invalid or is not set, NSAPI_ERROR_AUTH_ERROR is returned.
68+
* If the SIM requires a PIN, and it is invalid or not set, NSAPI_ERROR_AUTH_ERROR is returned.
6969
*
7070
* @return NSAPI_ERROR_OK on success, or negative error code on failure.
7171
*/
@@ -77,16 +77,16 @@ class CellularBase: public NetworkInterface {
7777
*/
7878
virtual nsapi_error_t disconnect() = 0;
7979

80-
/** Check if the connection is currently established or not.
80+
/** Check if the connection is currently established.
8181
*
82-
* @return True if the cellular module have successfully acquired a carrier and is
83-
* connected to an external packet data network using PPP, false otherwise.
82+
* @return `true` if the cellular module have successfully acquired a carrier and is
83+
* connected to an external packet data network using PPP, `false` otherwise.
8484
*/
8585
virtual bool is_connected() = 0;
8686

8787
/** Get the local IP address.
8888
*
89-
* @return Null-terminated representation of the local IP address
89+
* @return Null-terminated representation of the local IP address,
9090
* or null if no IP address has been received.
9191
*/
9292
virtual const char *get_ip_address() = 0;
@@ -118,10 +118,10 @@ class CellularBase: public NetworkInterface {
118118
/** Get the target's default cellular interface.
119119
*
120120
* This is provided as a weak method so targets can override. The
121-
* default implementation configures and returns the OnBoardModemInterface
121+
* default implementation configures and returns the OnBoardModemInterface,
122122
* if available.
123123
*
124-
* @return pointer to interface, if any
124+
* @return Pointer to interface, if any.
125125
*/
126126
static CellularBase *get_target_default_instance();
127127

0 commit comments

Comments
 (0)