ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Cellular: unified return value comments on API folder.

pull/8814/head
Teppo Järvelin 2018-11-19 16:17:30 +02:00
parent 9aef9d3661
commit c6205628d6
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
features/cellular/framework/API/CellularDevice.h
View File

@ -225,7 +225,11 @@ public:
* For example, when multiple modules are supported in a single AT driver this function detects * For example, when multiple modules are supported in a single AT driver this function detects
* and adapts to an actual module at runtime. * and adapts to an actual module at runtime.
* *
* @return 0 on success * @return NSAPI_ERROR_OK on success
* NSAPI_ERROR_NO_MEMORY on case of memory failure
* NSAPI_ERROR_UNSUPPORTED if current model is not detected
* NSAPI_ERROR_DEVICE_ERROR if model information could not be read
*
*/ */
virtual nsapi_error_t init_module() = 0; virtual nsapi_error_t init_module() = 0;

2
features/cellular/framework/API/CellularInformation.h
View File

@ -80,7 +80,7 @@ public:
IMEISV = 2, // IMEI and Software Version number IMEISV = 2, // IMEI and Software Version number
SVN = 3 // Software Version Number SVN = 3 // Software Version Number
}; };
virtual nsapi_size_or_error_t get_serial_number(char *buf, size_t buf_size, SerialNumberType type = SN) = 0; virtual nsapi_error_t get_serial_number(char *buf, size_t buf_size, SerialNumberType type = SN) = 0;
}; };
} // namespace mbed } // namespace mbed