Cellular: unified return value comments on API folder.

[jarvte]

Description

_ Fixed cellular API folder to follow same syntax when defining doxygen return values.
-CellularInformation had wrong return type (which is correct on deriving classes), fixed to correct return value. Does this make this Breaking change? Changed from nsapi_size_or_error_t to nsapi_error_t. Function implementation has returned only error codes.

@mirelachirica please review

Pull request type

[X] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[ ] Docs update
[ ] Test update
[ ] Breaking change

[jarvte]

travis-ci/events failed, not related to this pr.

[0xc0170]

Does this make this Breaking change? Changed from nsapi_size_or_error_t to nsapi_error_t. Function implementation has returned only error codes.

I would assume yes, in features/cellular/framework/API/CellularInformation.h. How does this affect a user ?

I restarted the events job

[jarvte]

I would assume yes, in features/cellular/framework/API/CellularInformation.h. How does this affect a user ?

It should not affect as implementation has not changed, it has never returned any size/length. Only way it affects is that application should expect nsapi_error_t instead of nsapi_size_or_error_t. Both are typedefs to signed int. I'll change to breaking change,.

[AnttiKauppila]

This is a breaking change because function prototype is modified.

[bulislaw]

@AnttiKauppila we are committed to maintaining backward compatibility. Is this necessary?

[kjbracey]

Even if those were different scalar types, I'd struggle to call this a "breaking change", but in this case they're both typedefs to the same thing! It's reformatting!

[AnttiKauppila]

I was wrong, I just quickly read the code. I checked and both return values are signed int's so it is not a breaking change after all!

[0xc0170]

PR type updated accordingly.

@bulislaw This should be ready for CI now, labeling as such

[0xc0170]

CI started

[mbed-ci]

Test run: SUCCESS

Summary: 4 of 4 test jobs passed
Build number : 1
Build artifacts
Build logs