Skip to content

Commit 446c428

Browse files
author
Amanda Butler
authored
Edit CellularContext.h
Edit file for complete sentences and correct commas.
1 parent 411320a commit 446c428

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

features/cellular/framework/API/CellularContext.h

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ class CellularContext : public CellularBase {
9898
// pointer for next item when used as a linked list
9999
CellularContext *_next;
100100
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.
102102
friend class CellularDevice;
103103
virtual ~CellularContext() {}
104104

@@ -109,10 +109,10 @@ class CellularContext : public CellularBase {
109109

110110
/** Register callback for status reporting.
111111
*
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.
114114
*
115-
* @remark deleting CellularDevice/CellularContext in callback not allowed.
115+
* @remark deleting CellularDevice/CellularContext in callback is not allowed.
116116
*
117117
* @param status_cb The callback for status changes.
118118
*/
@@ -132,13 +132,13 @@ class CellularContext : public CellularBase {
132132
static CellularContext *get_default_instance();
133133

134134

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.
136136

137137
/** Start the interface
138138
*
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
142142
* attach(...)
143143
*
144144
* @return NSAPI_ERROR_OK on success
@@ -148,9 +148,9 @@ class CellularContext : public CellularBase {
148148

149149
/** Start the interface
150150
*
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
154154
* attach(...)
155155
*
156156
* @return NSAPI_ERROR_OK on success
@@ -161,8 +161,8 @@ class CellularContext : public CellularBase {
161161
/** Start the interface
162162
*
163163
* 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
166166
* attach(...)
167167
*
168168
* @return NSAPI_ERROR_OK on success
@@ -173,8 +173,8 @@ class CellularContext : public CellularBase {
173173
/** Start the interface
174174
*
175175
* 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
178178
* attach(...)
179179
*
180180
* @return NSAPI_ERROR_OK on success
@@ -196,7 +196,7 @@ class CellularContext : public CellularBase {
196196
virtual nsapi_error_t get_rate_control(CellularContext::RateControlExceptionReports &reports,
197197
CellularContext::RateControlUplinkTimeUnit &time_unit, int &uplink_rate) = 0;
198198

199-
/** Get the relevant information for an active non secondary PDP context.
199+
/** Get the relevant information for an active nonsecondary PDP context.
200200
*
201201
* @remark optional params are not updated if not received from network.
202202
* @param params_list reference to linked list, which is filled on successful call
@@ -215,7 +215,7 @@ class CellularContext : public CellularBase {
215215
*/
216216
virtual nsapi_error_t get_apn_backoff_timer(int &backoff_timer) = 0;
217217

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.
219219
*
220220
* @param fh file handle for communicating with the modem
221221
*/
@@ -232,8 +232,7 @@ class CellularContext : public CellularBase {
232232
OP_MAX = 5
233233
};
234234

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.
237236
*
238237
* @param ev event type
239238
* @param ptr event-type dependent reason parameter

0 commit comments

Comments
 (0)