Skip to content

Commit 23da904

Browse files
author
Amanda Butler
authored
Copy edit CellularSIM.h
Copy edit for parallelism, and fix typo and capitalization from before these changes.
1 parent 14e1745 commit 23da904

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

features/cellular/framework/API/CellularSIM.h

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -55,33 +55,33 @@ class CellularSIM {
5555
*
5656
* @param sim_pin PIN for the SIM card
5757
* @return NSAPI_ERROR_OK on success
58-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
58+
* NSAPI_ERROR_DEVICE_ERROR on failure
5959
*/
6060
virtual nsapi_error_t set_pin(const char *sim_pin) = 0;
6161

62-
/** Change sim pin code.
62+
/** Change SIM pin code.
6363
*
64-
* @param sim_pin Current PIN for sim
65-
* @param new_pin New PIN for sim
64+
* @param sim_pin Current PIN for SIM
65+
* @param new_pin New PIN for SIM
6666
* @return NSAPI_ERROR_OK on success
67-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
67+
* NSAPI_ERROR_DEVICE_ERROR on failure
6868
*/
6969
virtual nsapi_error_t change_pin(const char *sim_pin, const char *new_pin) = 0;
7070

7171
/** Change is pin query needed after boot
7272
*
7373
* @param sim_pin Valid PIN for SIM card
74-
* @param query_pin False is PIN query not needed, True if PIN query needed after boot.
74+
* @param query_pin False if PIN query not needed, True if PIN query needed after boot.
7575
* @return NSAPI_ERROR_OK on success
76-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
76+
* NSAPI_ERROR_DEVICE_ERROR on failure
7777
*/
7878
virtual nsapi_error_t set_pin_query(const char *sim_pin, bool query_pin) = 0;
7979

80-
/** Get sim card's state
80+
/** Get SIM card's state
8181
*
8282
* @param state current state of SIM
8383
* @return NSAPI_ERROR_OK on success
84-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
84+
* NSAPI_ERROR_DEVICE_ERROR on failure
8585
*/
8686
virtual nsapi_error_t get_sim_state(SimState &state) = 0;
8787

@@ -91,7 +91,7 @@ class CellularSIM {
9191
* @param imsi preallocated char* which after successful request contains imsi
9292
* @return NSAPI_ERROR_OK on success
9393
* NSAPI_ERROR_PARAMETER if imsi if null
94-
* NSAPI_ERROR_DEVICE_ERROR on case of other failures
94+
* NSAPI_ERROR_DEVICE_ERROR on other failures
9595
*/
9696
virtual nsapi_error_t get_imsi(char *imsi) = 0;
9797

@@ -100,7 +100,7 @@ class CellularSIM {
100100
* @param buf SIM ICCID as zero terminated string
101101
* @param buf_size max length of SIM ICCID is MAX_ICCID_LENGTH
102102
* @return NSAPI_ERROR_OK on success
103-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
103+
* NSAPI_ERROR_DEVICE_ERROR on failure
104104
*/
105105
virtual nsapi_error_t get_iccid(char *buf, size_t buf_size) = 0;
106106
};

0 commit comments

Comments
 (0)