platform_hardware_interfaces/radio/1.2
Nathan Harold 5109018dfa Explicitly Document INT_MAX for Invalid Fields
When fields are inapplicable, they should not
be set to a clearly out-of-range value to signal
to the framework that those fields are not used.
In some cases, there is an in-range invalid value
that has been defined by the standards. The docs
are inconsistent in calling out INT_MAX as the
value to be used when something is inapplicable
vs the case when a measurement is simply not
reported. In all cases, INT_MAX can be used to
denote an invalid value, and in cases where the
field/structure is inapplicable, it is the correct
value. This CL updates all the docstrings for
SignalStrength-related fields to clarify that
INT_MAX is the correct "invalid" value for cases
when fields are inapplicable.

Bug: 123088652
Test: compilation (docstring-only change); CTS
    naturally enforces this change on devices with
    newer HALs; backwards compatibility is preserved
    for existing HAL versions.

Change-Id: I5cfa917f504d15691ab3f2c298189bdd47794a42
2019-01-28 18:59:08 -08:00
..
default Radio Sap 1.2 default implementation 2018-04-16 12:01:50 -07:00
vts pack VTS cc_test binaries as general-tests 2018-12-07 10:49:56 -08:00
Android.bp Update RegState for new CellIdentity types 2018-03-30 15:57:24 -07:00
IRadio.hal Add docs for setSignalStrengthReportingCriteria 2018-06-27 01:22:20 +00:00
IRadioIndication.hal Update documentation for currentPhysicalChannelConfigs() 2018-02-22 11:43:09 -08:00
IRadioResponse.hal Update RegState for new CellIdentity types 2018-03-30 15:57:24 -07:00
ISap.hal Update comments for doc comments. 2018-05-21 14:36:29 -07:00
types.hal Explicitly Document INT_MAX for Invalid Fields 2019-01-28 18:59:08 -08:00