diff options
author | Nathan Harold <nharold@google.com> | 2019-01-28 13:07:27 -0800 |
---|---|---|
committer | Nathan Harold <nharold@google.com> | 2019-01-28 18:59:08 -0800 |
commit | 5109018dfa4055379690aceb8c6aa5eb8b2250d1 (patch) | |
tree | 786c332b153874117a0ca6543f452f00d3cabfaf /camera/common/1.0/default/CameraModule.cpp | |
parent | 7c2fd0b19a6e5ff51d0312c9545a02994e9b1453 (diff) |
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
Diffstat (limited to 'camera/common/1.0/default/CameraModule.cpp')
0 files changed, 0 insertions, 0 deletions