Skip to content

Commit 9d4bb83

Browse files
author
Amanda Butler
authored
Copy edit CellularNetwork.h
Copy edit file for parallelism and active voice.
1 parent 7181afc commit 9d4bb83

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

‎features/cellular/framework/API/CellularNetwork.h

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -227,23 +227,23 @@ class CellularNetwork : public NetworkInterface {
227227
*
228228
* @remark must be called immediately after constructor.
229229
* @return NSAPI_ERROR_OK on success
230-
* NSAPI_ERROR_NO_MEMORY on case of memory failure
230+
* NSAPI_ERROR_NO_MEMORY on memory failure
231231
*/
232232
virtual nsapi_error_t init() = 0;
233233

234234
/** Request registering to network.
235235
*
236236
* @param plmn format is in numeric format or 0 for automatic network registration
237237
* @return NSAPI_ERROR_OK on success
238-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
238+
* NSAPI_ERROR_DEVICE_ERROR on failure
239239
*/
240240
virtual nsapi_error_t set_registration(const char *plmn = 0) = 0;
241241

242242
/** Get the current network registering mode
243243
*
244244
* @param mode on successful return contains the current network registering mode
245245
* @return NSAPI_ERROR_OK on success
246-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
246+
* NSAPI_ERROR_DEVICE_ERROR on failure
247247
*/
248248
virtual nsapi_error_t get_network_registering_mode(NWRegisteringMode &mode) = 0;
249249

@@ -253,10 +253,10 @@ class CellularNetwork : public NetworkInterface {
253253
* registration statue, access technology, cell id...
254254
*
255255
* @param type RegistrationType to set urc on/off
256-
* @param on Controls are urc' active or not
256+
* @param on Controls are urc active or not
257257
* @return NSAPI_ERROR_OK on success
258-
* NSAPI_ERROR_UNSUPPORTED if RegistrationType not supported by the modem
259-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
258+
* NSAPI_ERROR_UNSUPPORTED if the modem does not support RegistrationType
259+
* NSAPI_ERROR_DEVICE_ERROR on failure
260260
*/
261261
virtual nsapi_error_t set_registration_urc(RegistrationType type, bool on) = 0;
262262

@@ -265,8 +265,8 @@ class CellularNetwork : public NetworkInterface {
265265
* @param type see RegistrationType values
266266
* @param status see RegistrationStatus values
267267
* @return NSAPI_ERROR_OK on success
268-
* NSAPI_ERROR_UNSUPPORTED if RegistrationType not supported by the modem
269-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
268+
* NSAPI_ERROR_UNSUPPORTED if the modem does not support RegistrationType
269+
* NSAPI_ERROR_DEVICE_ERROR on failure
270270
*/
271271
virtual nsapi_error_t get_registration_status(RegistrationType type, RegistrationStatus &status) = 0;
272272

@@ -276,7 +276,7 @@ class CellularNetwork : public NetworkInterface {
276276
* @param username Optional username for the APN
277277
* @param password Optional password fot the APN
278278
* @return NSAPI_ERROR_OK on success
279-
* NSAPI_ERROR_NO_MEMORY on case of memory failure
279+
* NSAPI_ERROR_NO_MEMORY on memory failure
280280
*/
281281
virtual nsapi_error_t set_credentials(const char *apn,
282282
const char *username = 0, const char *password = 0) = 0;
@@ -288,7 +288,7 @@ class CellularNetwork : public NetworkInterface {
288288
* @param username Optional username for the APN
289289
* @param password Optional password fot the APN
290290
* @return NSAPI_ERROR_OK on success
291-
* NSAPI_ERROR_NO_MEMORY on case of memory failure
291+
* NSAPI_ERROR_NO_MEMORY on memory failure
292292
*/
293293
virtual nsapi_error_t set_credentials(const char *apn, AuthenticationType type,
294294
const char *username = 0, const char *password = 0) = 0;
@@ -298,7 +298,7 @@ class CellularNetwork : public NetworkInterface {
298298
* @deprecated Parameter timeout will be deprecated. Use mbed-os/features/cellular/framework/API/CellularDevice.h set_timeout instead.
299299
* @param timeout milliseconds to wait for attach response
300300
* @return NSAPI_ERROR_OK on success
301-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
301+
* NSAPI_ERROR_DEVICE_ERROR on failure
302302
*/
303303
MBED_DEPRECATED_SINCE("mbed-os-5.9", "Parameter timeout will be deprecated. Use mbed-os/features/cellular/framework/API/CellularDevice.h set_timeout instead.")
304304
virtual nsapi_error_t set_attach(int timeout = 10 * 1000) = 0;
@@ -307,14 +307,14 @@ class CellularNetwork : public NetworkInterface {
307307
*
308308
* @param status see AttachStatus values
309309
* @return NSAPI_ERROR_OK on success
310-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
310+
* NSAPI_ERROR_DEVICE_ERROR on failure
311311
*/
312312
virtual nsapi_error_t get_attach(AttachStatus &status) = 0;
313313

314314
/** Request detach from a network.
315315
*
316316
* @return NSAPI_ERROR_OK on success
317-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
317+
* NSAPI_ERROR_DEVICE_ERROR on failure
318318
*/
319319
virtual nsapi_error_t detach() = 0;
320320

@@ -335,7 +335,7 @@ class CellularNetwork : public NetworkInterface {
335335
* @param backoff_timer Backoff timer value associated with PDP APN in seconds
336336
* @return NSAPI_ERROR_OK on success
337337
* NSAPI_ERROR_PARAMETER if no access point is set or found when activating context
338-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
338+
* NSAPI_ERROR_DEVICE_ERROR on failure
339339
*/
340340
virtual nsapi_error_t get_apn_backoff_timer(int &backoff_timer) = 0;
341341

@@ -361,8 +361,8 @@ class CellularNetwork : public NetworkInterface {
361361
* @param operators Container of reachable operators and their access technologies
362362
* @param ops_count Number of found operators
363363
* @return NSAPI_ERROR_OK on success
364-
* NSAPI_ERROR_NO_MEMORY on case of memory failure
365-
* NSAPI_ERROR_DEVICE_ERROR on case of other failures
364+
* NSAPI_ERROR_NO_MEMORY on memory failure
365+
* NSAPI_ERROR_DEVICE_ERROR on other failures
366366
*/
367367
virtual nsapi_error_t scan_plmn(operList_t &operators, int &ops_count) = 0;
368368

@@ -371,7 +371,7 @@ class CellularNetwork : public NetworkInterface {
371371
* @param supported_opt Supported CIoT EPS optimizations.
372372
* @param preferred_opt Preferred CIoT EPS optimizations.
373373
* @return NSAPI_ERROR_OK on success
374-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
374+
* NSAPI_ERROR_DEVICE_ERROR on failure
375375
*/
376376
virtual nsapi_error_t set_ciot_optimization_config(Supported_UE_Opt supported_opt,
377377
Preferred_UE_Opt preferred_opt) = 0;
@@ -381,7 +381,7 @@ class CellularNetwork : public NetworkInterface {
381381
* @param supported_opt Supported CIoT EPS optimizations.
382382
* @param preferred_opt Preferred CIoT EPS optimizations.
383383
* @return NSAPI_ERROR_OK on success
384-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
384+
* NSAPI_ERROR_DEVICE_ERROR on failure
385385
*/
386386
virtual nsapi_error_t get_ciot_optimization_config(Supported_UE_Opt &supported_opt,
387387
Preferred_UE_Opt &preferred_opt) = 0;
@@ -393,7 +393,7 @@ class CellularNetwork : public NetworkInterface {
393393
* NSAPI_ERROR_UNSUPPORTED if NetworkStack was not found
394394
* NSAPI_ERROR_AUTH_FAILURE if password and username were provided and authentication to network failed
395395
* Also if PPP mode
396-
* NSAPI_ERROR_DEVICE_ERROR on case of failure and check more error from nsapi_ppp_connect(...)
396+
* NSAPI_ERROR_DEVICE_ERROR on failure and check more error from nsapi_ppp_connect(...)
397397
*/
398398
virtual nsapi_error_t connect() = 0;
399399

@@ -406,9 +406,9 @@ class CellularNetwork : public NetworkInterface {
406406
* NSAPI_ERROR_NO_CONNECTION if fails to find suitable context to activate or activation failed (if not already activated)
407407
* NSAPI_ERROR_UNSUPPORTED if NetworkStack was not found
408408
* NSAPI_ERROR_AUTH_FAILURE if password and username were provided and authentication to network failed
409-
* NSAPI_ERROR_NO_MEMORY on case of memory failure
409+
* NSAPI_ERROR_NO_MEMORY on memory failure
410410
* Also if PPP mode
411-
* NSAPI_ERROR_DEVICE_ERROR on case of failure and check more error from nsapi_ppp_connect(...)
411+
* NSAPI_ERROR_DEVICE_ERROR on failure and check more error from nsapi_ppp_connect(...)
412412
*/
413413
virtual nsapi_error_t connect(const char *apn,
414414
const char *username = 0, const char *password = 0) = 0;
@@ -429,7 +429,7 @@ class CellularNetwork : public NetworkInterface {
429429
* @param stack_type the stack type to be used.
430430
*
431431
* @return NSAPI_ERROR_OK on success
432-
* NSAPI_ERROR_PARAMETER if modem don't support the given stack_type
432+
* NSAPI_ERROR_PARAMETER if modem does not support the given stack_type
433433
*/
434434
virtual nsapi_error_t set_stack_type(nsapi_ip_stack_t stack_type) = 0;
435435

@@ -443,10 +443,10 @@ class CellularNetwork : public NetworkInterface {
443443
/** Get the relevant information for an active non secondary PDP context.
444444
*
445445
* @remark optional params are not updated if not received from network.
446-
* @param params_list reference to linked list which is filled on successful call
446+
* @param params_list reference to linked list, which is filled on successful call
447447
* @return NSAPI_ERROR_OK on success
448-
* NSAPI_ERROR_NO_MEMORY on case of memory failure
449-
* NSAPI_ERROR_DEVICE_ERROR on case of other failures
448+
* NSAPI_ERROR_NO_MEMORY on memory failure
449+
* NSAPI_ERROR_DEVICE_ERROR on other failures
450450
*/
451451
virtual nsapi_error_t get_pdpcontext_params(pdpContextList_t &params_list) = 0;
452452

@@ -459,7 +459,7 @@ class CellularNetwork : public NetworkInterface {
459459
* @param rsrq signal received quality
460460
* @param rsrp signal received power
461461
* @return NSAPI_ERROR_OK on success
462-
* NSAPI_ERROR_DEVICE_ERROR on case of other failures
462+
* NSAPI_ERROR_DEVICE_ERROR on other failures
463463
*/
464464
virtual nsapi_error_t get_extended_signal_quality(int &rxlev, int &ber, int &rscp, int &ecno, int &rsrq, int &rsrp) = 0;
465465

@@ -468,13 +468,13 @@ class CellularNetwork : public NetworkInterface {
468468
* @param rssi signal strength level
469469
* @param ber bit error rate
470470
* @return NSAPI_ERROR_OK on success
471-
* NSAPI_ERROR_DEVICE_ERROR on case of other failures
471+
* NSAPI_ERROR_DEVICE_ERROR on other failures
472472
*/
473473
virtual nsapi_error_t get_signal_quality(int &rssi, int &ber) = 0;
474474

475475
/** Get cell id.
476476
*
477-
* @param cell_id cell id
477+
* @param cell_id cell ID
478478
* @return NSAPI_ERROR_OK
479479
*/
480480
virtual nsapi_error_t get_cell_id(int &cell_id) = 0;
@@ -519,10 +519,10 @@ class CellularNetwork : public NetworkInterface {
519519

520520
/** Read operator names
521521
*
522-
* @param op_names on successful return will contain linked list of operator names.
522+
* @param op_names on successful return contains linked list of operator names.
523523
* @return NSAPI_ERROR_OK on success
524-
* NSAPI_ERROR_NO_MEMORY on case of memory failure
525-
* NSAPI_ERROR_DEVICE_ERROR on case of other failures
524+
* NSAPI_ERROR_NO_MEMORY on memory failure
525+
* NSAPI_ERROR_DEVICE_ERROR on other failures
526526
*/
527527
virtual nsapi_error_t get_operator_names(operator_names_list &op_names) = 0;
528528
};

0 commit comments

Comments
 (0)