Skip to content

Commit 5086c3d

Browse files
authored
Merge pull request #8814 from jarvte/unify_cellular_return
Cellular: unified return value comments on API folder.
2 parents cb6f5d6 + c620562 commit 5086c3d

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

features/cellular/framework/API/CellularDevice.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,11 @@ class CellularDevice {
225225
* For example, when multiple modules are supported in a single AT driver this function detects
226226
* and adapts to an actual module at runtime.
227227
*
228-
* @return 0 on success
228+
* @return NSAPI_ERROR_OK on success
229+
* NSAPI_ERROR_NO_MEMORY on case of memory failure
230+
* NSAPI_ERROR_UNSUPPORTED if current model is not detected
231+
* NSAPI_ERROR_DEVICE_ERROR if model information could not be read
232+
*
229233
*/
230234
virtual nsapi_error_t init_module() = 0;
231235

features/cellular/framework/API/CellularInformation.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ class CellularInformation {
8080
IMEISV = 2, // IMEI and Software Version number
8181
SVN = 3 // Software Version Number
8282
};
83-
virtual nsapi_size_or_error_t get_serial_number(char *buf, size_t buf_size, SerialNumberType type = SN) = 0;
83+
virtual nsapi_error_t get_serial_number(char *buf, size_t buf_size, SerialNumberType type = SN) = 0;
8484
};
8585

8686
} // namespace mbed

0 commit comments

Comments
 (0)