@@ -98,7 +98,7 @@ class CellularContext : public CellularBase {
98
98
// pointer for next item when used as a linked list
99
99
CellularContext *_next;
100
100
protected:
101
- // friend of CellularDevice so that it's the only way to close/ delete this class.
101
+ // friend of CellularDevice, so it's the only way to close or delete this class.
102
102
friend class CellularDevice ;
103
103
virtual ~CellularContext () {}
104
104
@@ -109,10 +109,10 @@ class CellularContext : public CellularBase {
109
109
110
110
/* * Register callback for status reporting.
111
111
*
112
- * The specified status callback function will be called on the network and cellular device status changes.
113
- * The parameters on the callback are the event type and event- type dependent reason parameter.
112
+ * The specified status callback function is called on the network, and the cellular device status changes.
113
+ * The parameters on the callback are the event type and event type dependent reason parameter.
114
114
*
115
- * @remark deleting CellularDevice/CellularContext in callback not allowed.
115
+ * @remark deleting CellularDevice/CellularContext in callback is not allowed.
116
116
*
117
117
* @param status_cb The callback for status changes.
118
118
*/
@@ -132,13 +132,13 @@ class CellularContext : public CellularBase {
132
132
static CellularContext *get_default_instance ();
133
133
134
134
135
- // Operations, can be sync/async. Also Connect() is this kind of operations , inherited from NetworkInterface above.
135
+ // Operations, can be sync/async. Also Connect() is this kind of operation , inherited from NetworkInterface above.
136
136
137
137
/* * Start the interface
138
138
*
139
- * Power on the device and does the initializations for communication with the modem. .
140
- * By default this API is synchronous. API can be set to asynchronous with method set_blocking(...).
141
- * In synchronous and asynchronous mode application can get result in from callback which is set with
139
+ * Powers on the device and does the initializations for communication with the modem.
140
+ * By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...).
141
+ * In synchronous and asynchronous mode, the application can get result in from callback, which is set with
142
142
* attach(...)
143
143
*
144
144
* @return NSAPI_ERROR_OK on success
@@ -148,9 +148,9 @@ class CellularContext : public CellularBase {
148
148
149
149
/* * Start the interface
150
150
*
151
- * Attempts to open the sim .
152
- * By default this API is synchronous. API can be set to asynchronous with method set_blocking(...).
153
- * In synchronous and asynchronous mode application can get result in from callback which is set with
151
+ * Attempts to open the SIM .
152
+ * By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...).
153
+ * In synchronous and asynchronous mode, the application can get result in from callback, which is set with
154
154
* attach(...)
155
155
*
156
156
* @return NSAPI_ERROR_OK on success
@@ -161,8 +161,8 @@ class CellularContext : public CellularBase {
161
161
/* * Start the interface
162
162
*
163
163
* Attempts to register the device to cellular network.
164
- * By default this API is synchronous. API can be set to asynchronous with method set_blocking(...).
165
- * In synchronous and asynchronous mode application can get result in from callback which is set with
164
+ * By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...).
165
+ * In synchronous and asynchronous mode, the application can get result in from callback, which is set with
166
166
* attach(...)
167
167
*
168
168
* @return NSAPI_ERROR_OK on success
@@ -173,8 +173,8 @@ class CellularContext : public CellularBase {
173
173
/* * Start the interface
174
174
*
175
175
* Attempts to attach the device to cellular network.
176
- * By default this API is synchronous. API can be set to asynchronous with method set_blocking(...).
177
- * In synchronous and asynchronous mode application can get result in from callback which is set with
176
+ * By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...).
177
+ * In synchronous and asynchronous mode, the application can get result in from callback, which is set with
178
178
* attach(...)
179
179
*
180
180
* @return NSAPI_ERROR_OK on success
@@ -196,7 +196,7 @@ class CellularContext : public CellularBase {
196
196
virtual nsapi_error_t get_rate_control (CellularContext::RateControlExceptionReports &reports,
197
197
CellularContext::RateControlUplinkTimeUnit &time_unit, int &uplink_rate) = 0;
198
198
199
- /* * Get the relevant information for an active non secondary PDP context.
199
+ /* * Get the relevant information for an active nonsecondary PDP context.
200
200
*
201
201
* @remark optional params are not updated if not received from network.
202
202
* @param params_list reference to linked list, which is filled on successful call
@@ -215,7 +215,7 @@ class CellularContext : public CellularBase {
215
215
*/
216
216
virtual nsapi_error_t get_apn_backoff_timer (int &backoff_timer) = 0;
217
217
218
- /* * Set the file handle used to communicate with the modem. Can be used to change default file handle.
218
+ /* * Set the file handle used to communicate with the modem. You can use this to change the default file handle.
219
219
*
220
220
* @param fh file handle for communicating with the modem
221
221
*/
@@ -232,8 +232,7 @@ class CellularContext : public CellularBase {
232
232
OP_MAX = 5
233
233
};
234
234
235
- /* * Status callback function will be called on status changes on the network or CellularDevice
236
- * by the CellularDevice.
235
+ /* * The CellularDevice calls the status callback function on status changes on the network or CellularDevice.
237
236
*
238
237
* @param ev event type
239
238
* @param ptr event-type dependent reason parameter
0 commit comments