Skip to content

Commit 14e1745

Browse files
author
Amanda Butler
authored
Copy edit CellularPower.h
Copy edit file for parallelism, and fix typo
1 parent 9d4bb83 commit 14e1745

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

features/cellular/framework/API/CellularPower.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class CellularPower {
7272
* @remark must be called after power on to prepare correct AT mode
7373
*
7474
* @return NSAPI_ERROR_OK on success
75-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
75+
* NSAPI_ERROR_DEVICE_ERROR on failure
7676
*/
7777
virtual nsapi_error_t set_at_mode() = 0;
7878

@@ -91,26 +91,26 @@ class CellularPower {
9191
* @remark See 3GPP TS 27.007 CFUN for more details
9292
*
9393
* @return NSAPI_ERROR_OK on success
94-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
94+
* NSAPI_ERROR_DEVICE_ERROR on failure
9595
*/
9696
virtual nsapi_error_t set_power_level(int func_level, int do_reset = 0) = 0;
9797

9898
/** Reset and wake-up cellular device.
9999
*
100100
* @return NSAPI_ERROR_OK on success
101-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
101+
* NSAPI_ERROR_DEVICE_ERROR on failure
102102
*/
103103
virtual nsapi_error_t reset() = 0;
104104

105-
/** Opt for power save setting on cellular device. If both parameters are zero then disables PSM.
105+
/** Opt for power save setting on cellular device. If both parameters are zero, this disables PSM.
106106
*
107107
* @remark See 3GPP TS 27.007 PSM for details
108108
*
109109
* @param periodic_time Timeout in seconds IoT subsystem is not expecting messaging
110110
* @param active_time Timeout in seconds IoT subsystem waits for response
111111
*
112112
* @return NSAPI_ERROR_OK on success
113-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
113+
* NSAPI_ERROR_DEVICE_ERROR on failure
114114
*/
115115
virtual nsapi_error_t opt_power_save_mode(int periodic_time, int active_time) = 0;
116116

@@ -123,14 +123,14 @@ class CellularPower {
123123
* @param edrx_value requested edxr value. Extended DRX parameters information element.
124124
*
125125
* @return NSAPI_ERROR_OK on success
126-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
126+
* NSAPI_ERROR_DEVICE_ERROR on failure
127127
*/
128128
virtual nsapi_error_t opt_receive_period(int mode, EDRXAccessTechnology act_type, uint8_t edrx_value) = 0;
129129

130130
/** Check whether the device is ready to accept commands.
131131
*
132132
* @return NSAPI_ERROR_OK on success
133-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
133+
* NSAPI_ERROR_DEVICE_ERROR on failure
134134
*/
135135
virtual nsapi_error_t is_device_ready() = 0;
136136

@@ -141,7 +141,7 @@ class CellularPower {
141141
* @param callback Callback function called when urc received
142142
*
143143
* @return NSAPI_ERROR_OK on success
144-
* NSAPI_ERROR_NO_MEMORY on case of memory failure
144+
* NSAPI_ERROR_NO_MEMORY on memory failure
145145
* NSAPI_ERROR_UNSUPPORTED if not overridden by the target modem
146146
*/
147147
virtual nsapi_error_t set_device_ready_urc_cb(mbed::Callback<void()> callback) = 0;

0 commit comments

Comments
 (0)