From 9214894ebc24b2c600539ff78002330762c7e674 Mon Sep 17 00:00:00 2001 From: Tomasz Wasilczyk Date: Mon, 31 Jul 2017 15:04:35 -0700 Subject: [PATCH] Linguistic fixes for broadcastradio 1.1 HAL. Bug: b/64113304 Test: it builds Change-Id: I5d5d090a44146e327d7b0f69cc2ba97060f3b515 --- broadcastradio/1.1/IBroadcastRadio.hal | 12 +++++++----- broadcastradio/1.1/IBroadcastRadioFactory.hal | 6 ++++-- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/broadcastradio/1.1/IBroadcastRadio.hal b/broadcastradio/1.1/IBroadcastRadio.hal index 9bde361bdb..c722e40acd 100644 --- a/broadcastradio/1.1/IBroadcastRadio.hal +++ b/broadcastradio/1.1/IBroadcastRadio.hal @@ -31,19 +31,21 @@ interface IBroadcastRadio extends @1.0::IBroadcastRadio { * Fetch image from radio module. * * This call is meant to make V1_0::MetaData lightweight - instead of - * passing image data blob in MetadataType.RAW field, only identifier is - * passed, so the client may cache images or even not fetch them. + * passing an image data blob in the MetadataType.RAW field, the HAL + * implementation only passes the identifier, so the client may cache images + * or even not fetch them. * - * Identifier may be any arbitrary number - sequential, sha256 prefix, + * The identifier may be any arbitrary number - sequential, sha256 prefix, * or any other unique value selected by the vendor. * * The data should be a valid PNG, JPEG, GIF or BMP file. - * Invalid format must be handled gracefully as if the image was missing. + * Image data with an invalid format must be handled gracefully in the same + * way as a missing image. * * @param id Identifier of an image; * value of 0 is reserved and should be treated as invalid image. * @return image A binary blob with image data - * or zero-length vector if identifier doesn't exists. + * or a zero-length vector if identifier doesn't exist. */ getImage(int32_t id) generates (vec image); }; diff --git a/broadcastradio/1.1/IBroadcastRadioFactory.hal b/broadcastradio/1.1/IBroadcastRadioFactory.hal index fce1cc0c72..edf78ff09a 100644 --- a/broadcastradio/1.1/IBroadcastRadioFactory.hal +++ b/broadcastradio/1.1/IBroadcastRadioFactory.hal @@ -19,8 +19,10 @@ package android.hardware.broadcastradio@1.1; import @1.0::IBroadcastRadioFactory; /** - * To use 1.1 features you must cast specific interfaces after being returned from 1.0 HAL, - * for example V1_1::ITuner::castFrom() after retrieving it from IBroadcastRadio::openTuner(). + * To use 1.1 features you must cast specific interfaces returned from the + * 1.0 HAL. For example V1_0::IBroadcastRadio::openTuner() returns V1_0::ITuner, + * which can be cast with V1_1::ITuner::castFrom() call. + * * The 1.1 server must always return the 1.1 version of specific interface. */ interface IBroadcastRadioFactory extends @1.0::IBroadcastRadioFactory {