@@ -45,13 +45,13 @@ class CellularBase: public NetworkInterface {
45
45
virtual void set_credentials (const char *apn, const char *uname = 0 ,
46
46
const char *pwd = 0 ) = 0;
47
47
48
- /* * Set the pin code for SIM card.
48
+ /* * Set the PIN code for SIM card.
49
49
*
50
50
* @param sim_pin PIN for the SIM card.
51
51
*/
52
52
virtual void set_sim_pin (const char *sim_pin) = 0;
53
53
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.
55
55
*
56
56
* @param sim_pin PIN for the SIM card.
57
57
* @param apn Access point name (optional).
@@ -65,7 +65,7 @@ class CellularBase: public NetworkInterface {
65
65
66
66
/* * Attempt to connect to a cellular network.
67
67
*
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.
69
69
*
70
70
* @return NSAPI_ERROR_OK on success, or negative error code on failure.
71
71
*/
@@ -77,16 +77,16 @@ class CellularBase: public NetworkInterface {
77
77
*/
78
78
virtual nsapi_error_t disconnect () = 0;
79
79
80
- /* * Check if the connection is currently established or not .
80
+ /* * Check if the connection is currently established.
81
81
*
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.
84
84
*/
85
85
virtual bool is_connected () = 0;
86
86
87
87
/* * Get the local IP address.
88
88
*
89
- * @return Null-terminated representation of the local IP address
89
+ * @return Null-terminated representation of the local IP address,
90
90
* or null if no IP address has been received.
91
91
*/
92
92
virtual const char *get_ip_address () = 0;
@@ -118,10 +118,10 @@ class CellularBase: public NetworkInterface {
118
118
/* * Get the target's default cellular interface.
119
119
*
120
120
* 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,
122
122
* if available.
123
123
*
124
- * @return pointer to interface, if any
124
+ * @return Pointer to interface, if any.
125
125
*/
126
126
static CellularBase *get_target_default_instance ();
127
127
0 commit comments