Skip to content

Commit 08312f3

Browse files
Amanda ButlerCruz Monrreal II
authored andcommitted
Copy edit CellularSIM.h
Copy edit for parallelism, and fix typo and capitalization from before these changes.
1 parent a8116b1 commit 08312f3

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

features/cellular/framework/API/CellularSIM.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,33 +53,33 @@ class CellularSIM
5353
*
5454
* @param sim_pin PIN for the SIM card
5555
* @return NSAPI_ERROR_OK on success
56-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
56+
* NSAPI_ERROR_DEVICE_ERROR on failure
5757
*/
5858
virtual nsapi_error_t set_pin(const char *sim_pin) = 0;
5959

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

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

78-
/** Get sim card's state
78+
/** Get SIM card's state
7979
*
8080
* @param state current state of SIM
8181
* @return NSAPI_ERROR_OK on success
82-
* NSAPI_ERROR_DEVICE_ERROR on case of failure
82+
* NSAPI_ERROR_DEVICE_ERROR on failure
8383
*/
8484
virtual nsapi_error_t get_sim_state(SimState &state) = 0;
8585

@@ -89,7 +89,7 @@ class CellularSIM
8989
* @param imsi preallocated char* which after successful request contains imsi
9090
* @return NSAPI_ERROR_OK on success
9191
* NSAPI_ERROR_PARAMETER if imsi if null
92-
* NSAPI_ERROR_DEVICE_ERROR on case of other failures
92+
* NSAPI_ERROR_DEVICE_ERROR on other failures
9393
*/
9494
virtual nsapi_error_t get_imsi(char *imsi) = 0;
9595
};

0 commit comments

Comments
 (0)