summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSteven Moreland2018-05-17 16:32:17 -0500
committerSteven Moreland2018-05-21 16:36:29 -0500
commit913c071391e096bd6b77510b285d746ee97c28ed (patch)
tree98acec7558b4d407cec4d6f75fd8a8c596bf3a2f
parent867726a9cbe1ebf5dae818dd989f1195b9f0c4a9 (diff)
downloadplatform-hardware-interfaces-android-o-mr1-iot-release-1.0.1.tar.gz
platform-hardware-interfaces-android-o-mr1-iot-release-1.0.1.tar.xz
platform-hardware-interfaces-android-o-mr1-iot-release-1.0.1.zip
Update comments for doc comments.android-o-mr1-iot-release-1.0.1
Doc comments look like "/** ... */" and they can only be in certain places. Bug: 79865343 Test: m Change-Id: Ic15c08ff7dc6e4f9827c1dbe7f7236c11a572ec1 Merged-In: Ic15c08ff7dc6e4f9827c1dbe7f7236c11a572ec1
-rw-r--r--broadcastradio/1.0/types.hal6
-rw-r--r--current.txt13
-rw-r--r--graphics/bufferqueue/1.0/IGraphicBufferProducer.hal2
-rw-r--r--graphics/composer/2.1/IComposerClient.hal4
-rw-r--r--graphics/composer/2.1/types.hal18
-rw-r--r--graphics/mapper/2.0/IMapper.hal4
-rw-r--r--graphics/mapper/2.0/types.hal12
-rw-r--r--keymaster/3.0/types.hal20
-rw-r--r--radio/1.1/ISap.hal9
-rw-r--r--radio/1.2/ISap.hal9
-rw-r--r--tv/cec/1.0/types.hal2
-rw-r--r--usb/1.1/IUsb.hal14
-rw-r--r--wifi/1.0/IWifiP2pIface.hal4
13 files changed, 63 insertions, 54 deletions
diff --git a/broadcastradio/1.0/types.hal b/broadcastradio/1.0/types.hal
index 8c3ec119..259c7c9e 100644
--- a/broadcastradio/1.0/types.hal
+++ b/broadcastradio/1.0/types.hal
@@ -136,7 +136,8 @@ struct Properties {
136 uint32_t numAudioSources; 136 uint32_t numAudioSources;
137 /** the hardware supports capture of audio source from audio HAL */ 137 /** the hardware supports capture of audio source from audio HAL */
138 bool supportsCapture; 138 bool supportsCapture;
139 vec<BandConfig> bands; /** band descriptors */ 139 /** band descriptors */
140 vec<BandConfig> bands;
140}; 141};
141 142
142enum MetadataType : int32_t { 143enum MetadataType : int32_t {
@@ -229,6 +230,7 @@ struct ProgramInfo {
229 */ 230 */
230 uint32_t signalStrength; 231 uint32_t signalStrength;
231 232
232 vec<MetaData> metadata; /** Metadata: PTY, song title etc. */ 233 /** Metadata: PTY, song title etc. */
234 vec<MetaData> metadata;
233}; 235};
234 236
diff --git a/current.txt b/current.txt
index 14cdaa0b..28f0f992 100644
--- a/current.txt
+++ b/current.txt
@@ -251,3 +251,16 @@ c8bc853546dd55584611def2a9fa1d99f657e3366c976d2f60fe6b8aa6d2cb87 android.hardwar
25112e8dca4ab7d8aadd0ef8f1b438021938e2396139e85db2ed65783b08800aa52 android.hardware.neuralnetworks@1.0::IExecutionCallback 25112e8dca4ab7d8aadd0ef8f1b438021938e2396139e85db2ed65783b08800aa52 android.hardware.neuralnetworks@1.0::IExecutionCallback
25218e6885e184fe48401c2c53f1d1b8bfb07240f40c81ae6b9d2e336fca6efdbb7 android.hardware.neuralnetworks@1.0::types 25218e6885e184fe48401c2c53f1d1b8bfb07240f40c81ae6b9d2e336fca6efdbb7 android.hardware.neuralnetworks@1.0::types
253 253
254# Documentation fixups for b/78135149
2559e7a0b650d0e461ece2cfec0e1072abf8676f592b41a7fb48f01e88fc3c8f780 android.hardware.broadcastradio@1.0::types
256190ea4898809de6cf379afe318f5fa9564686157b24d9a2d7f5698b0c977d8b2 android.hardware.graphics.bufferqueue@1.0::IGraphicBufferProducer
25725892789b50eb673506b6c5a2cdab5d9aa428d41608aab10280cc898538b524a android.hardware.graphics.composer@2.1::IComposerClient
258e205dd30f5ff99445b706a901de8ebc46c379e9d7c1921d6a327ed2082cfa83d android.hardware.graphics.composer@2.1::types
259a46251718abfada458dc64c41ce94915757bf6c87cfa2d9e99cfb01fa8e32331 android.hardware.graphics.mapper@2.0::IMapper
260bd33ac23c57b4a07632691d2191bc2c93930f57e62f4ccf459748fdaa5c0f480 android.hardware.graphics.mapper@2.0::types
261ad8a28ca3a5549fb9bc24cf5f80ac8f660cc27be885210d76266780aa52ddb8d android.hardware.keymaster@3.0::types
262f96cbc59dfe16c8d0c2a7e06db24d8738a6328b6e90f7b8e1640ea2b4600debd android.hardware.radio@1.1::ISap
2632d86929794795e5c70f4fdb5073485fd05835c9c6f496116687c3d9f32e6df3e android.hardware.radio@1.2::ISap
264905a4af79c8329b39d8b11b08f015137216bb078b427b6986f32884a04bc1bec android.hardware.tv.cec@1.0::types
265aebcd9ff2da05c9d4c439916f40dfd219ba7629919007cb981ebf150064b4f82 android.hardware.usb@1.1::IUsb
266e29fb1941b40a990676f8e9c676a38761defd890b81a9c034608eb7ba6496023 android.hardware.wifi@1.0::IWifiP2pIface
diff --git a/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal b/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal
index 87bb814a..c59a16cc 100644
--- a/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal
+++ b/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal
@@ -546,7 +546,7 @@ interface IGraphicBufferProducer {
546 */ 546 */
547 disconnect( 547 disconnect(
548 int32_t api, 548 int32_t api,
549 DisconnectMode mode /** = DisconnectMode::API */ 549 DisconnectMode mode /* = DisconnectMode::API */
550 ) generates ( 550 ) generates (
551 Status status 551 Status status
552 ); 552 );
diff --git a/graphics/composer/2.1/IComposerClient.hal b/graphics/composer/2.1/IComposerClient.hal
index f2ff932f..5ad46f01 100644
--- a/graphics/composer/2.1/IComposerClient.hal
+++ b/graphics/composer/2.1/IComposerClient.hal
@@ -1138,7 +1138,7 @@ interface IComposerClient {
1138 SET_LAYER_Z_ORDER = 0x40a << OPCODE_SHIFT, 1138 SET_LAYER_Z_ORDER = 0x40a << OPCODE_SHIFT,
1139 SET_PRESENT_OR_VALIDATE_DISPLAY_RESULT = 0x40b << OPCODE_SHIFT, 1139 SET_PRESENT_OR_VALIDATE_DISPLAY_RESULT = 0x40b << OPCODE_SHIFT,
1140 1140
1141 /** 0x800 - 0xfff are reserved for vendor extensions */ 1141 /* 0x800 - 0xfff are reserved for vendor extensions */
1142 /** 0x1000 - 0xffff are reserved */ 1142 /* 0x1000 - 0xffff are reserved */
1143 }; 1143 };
1144}; 1144};
diff --git a/graphics/composer/2.1/types.hal b/graphics/composer/2.1/types.hal
index 9f0dd8bc..eb0a73bb 100644
--- a/graphics/composer/2.1/types.hal
+++ b/graphics/composer/2.1/types.hal
@@ -18,15 +18,15 @@ package android.hardware.graphics.composer@2.1;
18 18
19/** Return codes from all functions. */ 19/** Return codes from all functions. */
20enum Error : int32_t { 20enum Error : int32_t {
21 NONE = 0, /** no error */ 21 NONE = 0, /* no error */
22 BAD_CONFIG = 1, /** invalid Config */ 22 BAD_CONFIG = 1, /* invalid Config */
23 BAD_DISPLAY = 2, /** invalid Display */ 23 BAD_DISPLAY = 2, /* invalid Display */
24 BAD_LAYER = 3, /** invalid Layer */ 24 BAD_LAYER = 3, /* invalid Layer */
25 BAD_PARAMETER = 4, /** invalid width, height, etc. */ 25 BAD_PARAMETER = 4, /* invalid width, height, etc. */
26 /** 5 is reserved */ 26 /* 5 is reserved */
27 NO_RESOURCES = 6, /** temporary failure due to resource contention */ 27 NO_RESOURCES = 6, /* temporary failure due to resource contention */
28 NOT_VALIDATED = 7, /** validateDisplay has not been called */ 28 NOT_VALIDATED = 7, /* validateDisplay has not been called */
29 UNSUPPORTED = 8, /** permanent failure */ 29 UNSUPPORTED = 8, /* permanent failure */
30}; 30};
31 31
32typedef uint32_t Config; 32typedef uint32_t Config;
diff --git a/graphics/mapper/2.0/IMapper.hal b/graphics/mapper/2.0/IMapper.hal
index 4ee206bc..45661357 100644
--- a/graphics/mapper/2.0/IMapper.hal
+++ b/graphics/mapper/2.0/IMapper.hal
@@ -155,7 +155,7 @@ interface IMapper {
155 * @param cpuUsage specifies one or more CPU usage flags to request. 155 * @param cpuUsage specifies one or more CPU usage flags to request.
156 * @param accessRegion is the portion of the buffer that the client 156 * @param accessRegion is the portion of the buffer that the client
157 * intends to access. 157 * intends to access.
158 * @param acquireFence, when non-empty, is a handle containing a file 158 * @param acquireFence when non-empty, is a handle containing a file
159 * descriptor referring to a sync fence object, which will be 159 * descriptor referring to a sync fence object, which will be
160 * signaled when it is safe for the mapper to lock the buffer. If 160 * signaled when it is safe for the mapper to lock the buffer. If
161 * it is already safe to lock, acquireFence is empty. 161 * it is already safe to lock, acquireFence is empty.
@@ -191,7 +191,7 @@ interface IMapper {
191 * @param cpuUsage specifies one or more CPU usage flags to request. 191 * @param cpuUsage specifies one or more CPU usage flags to request.
192 * @param accessRegion is the portion of the buffer that the client 192 * @param accessRegion is the portion of the buffer that the client
193 * intends to access. 193 * intends to access.
194 * @param acquireFence, when non-empty, is a handle containing a file 194 * @param acquireFence when non-empty, is a handle containing a file
195 * descriptor referring to a sync fence object, which will be 195 * descriptor referring to a sync fence object, which will be
196 * signaled when it is safe for the mapper to lock the buffer. If 196 * signaled when it is safe for the mapper to lock the buffer. If
197 * it is already safe to lock, acquireFence is empty. 197 * it is already safe to lock, acquireFence is empty.
diff --git a/graphics/mapper/2.0/types.hal b/graphics/mapper/2.0/types.hal
index e9b2f3a7..2291f700 100644
--- a/graphics/mapper/2.0/types.hal
+++ b/graphics/mapper/2.0/types.hal
@@ -17,14 +17,14 @@
17package android.hardware.graphics.mapper@2.0; 17package android.hardware.graphics.mapper@2.0;
18 18
19enum Error : int32_t { 19enum Error : int32_t {
20 NONE = 0, /** no error */ 20 NONE = 0, /* no error */
21 BAD_DESCRIPTOR = 1, /** invalid BufferDescriptor */ 21 BAD_DESCRIPTOR = 1, /* invalid BufferDescriptor */
22 BAD_BUFFER = 2, /** invalid buffer handle */ 22 BAD_BUFFER = 2, /* invalid buffer handle */
23 BAD_VALUE = 3, /** invalid width, height, etc. */ 23 BAD_VALUE = 3, /* invalid width, height, etc. */
24 /* 4 is reserved */ 24 /* 4 is reserved */
25 NO_RESOURCES = 5, /** temporary failure due to resource contention */ 25 NO_RESOURCES = 5, /* temporary failure due to resource contention */
26 /* 6 is reserved */ 26 /* 6 is reserved */
27 UNSUPPORTED = 7, /** permanent failure */ 27 UNSUPPORTED = 7, /* permanent failure */
28}; 28};
29 29
30/** 30/**
diff --git a/keymaster/3.0/types.hal b/keymaster/3.0/types.hal
index 6dad23e4..72f7d473 100644
--- a/keymaster/3.0/types.hal
+++ b/keymaster/3.0/types.hal
@@ -17,17 +17,17 @@
17package android.hardware.keymaster@3.0; 17package android.hardware.keymaster@3.0;
18 18
19enum TagType : uint32_t { 19enum TagType : uint32_t {
20 INVALID = 0 << 28, /** Invalid type, used to designate a tag as uninitialized */ 20 INVALID = 0 << 28, /* Invalid type, used to designate a tag as uninitialized */
21 ENUM = 1 << 28, 21 ENUM = 1 << 28,
22 ENUM_REP = 2 << 28, /** Repeatable enumeration value. */ 22 ENUM_REP = 2 << 28, /* Repeatable enumeration value. */
23 UINT = 3 << 28, 23 UINT = 3 << 28,
24 UINT_REP = 4 << 28, /** Repeatable integer value */ 24 UINT_REP = 4 << 28, /* Repeatable integer value */
25 ULONG = 5 << 28, 25 ULONG = 5 << 28,
26 DATE = 6 << 28, 26 DATE = 6 << 28,
27 BOOL = 7 << 28, 27 BOOL = 7 << 28,
28 BIGNUM = 8 << 28, 28 BIGNUM = 8 << 28,
29 BYTES = 9 << 28, 29 BYTES = 9 << 28,
30 ULONG_REP = 10 << 28, /** Repeatable long value */ 30 ULONG_REP = 10 << 28, /* Repeatable long value */
31}; 31};
32 32
33enum Tag : uint32_t { 33enum Tag : uint32_t {
@@ -254,12 +254,12 @@ enum KeyBlobUsageRequirements : uint32_t {
254 * Possible purposes of a key (or pair). 254 * Possible purposes of a key (or pair).
255 */ 255 */
256enum KeyPurpose : uint32_t { 256enum KeyPurpose : uint32_t {
257 ENCRYPT = 0, /** Usable with RSA, EC and AES keys. */ 257 ENCRYPT = 0, /* Usable with RSA, EC and AES keys. */
258 DECRYPT = 1, /** Usable with RSA, EC and AES keys. */ 258 DECRYPT = 1, /* Usable with RSA, EC and AES keys. */
259 SIGN = 2, /** Usable with RSA, EC and HMAC keys. */ 259 SIGN = 2, /* Usable with RSA, EC and HMAC keys. */
260 VERIFY = 3, /** Usable with RSA, EC and HMAC keys. */ 260 VERIFY = 3, /* Usable with RSA, EC and HMAC keys. */
261 DERIVE_KEY = 4, /** Usable with EC keys. */ 261 DERIVE_KEY = 4, /* Usable with EC keys. */
262 WRAP_KEY = 5, /** Usable with wrapping keys. */ 262 WRAP_KEY = 5, /* Usable with wrapping keys. */
263}; 263};
264 264
265/** 265/**
diff --git a/radio/1.1/ISap.hal b/radio/1.1/ISap.hal
index edcf176a..0cabccc1 100644
--- a/radio/1.1/ISap.hal
+++ b/radio/1.1/ISap.hal
@@ -18,8 +18,7 @@ package android.hardware.radio@1.1;
18 18
19import @1.0::ISap; 19import @1.0::ISap;
20 20
21interface ISap extends @1.0::ISap { 21/**
22 /** 22 * Empty top level interface.
23 * Empty top level interface. 23 */
24 */ 24interface ISap extends @1.0::ISap {};
25};
diff --git a/radio/1.2/ISap.hal b/radio/1.2/ISap.hal
index 757027ce..65f9b848 100644
--- a/radio/1.2/ISap.hal
+++ b/radio/1.2/ISap.hal
@@ -18,8 +18,7 @@ package android.hardware.radio@1.2;
18 18
19import @1.1::ISap; 19import @1.1::ISap;
20 20
21interface ISap extends @1.1::ISap { 21/**
22 /** 22 * Empty top level interface.
23 * Empty top level interface. 23 */
24 */ 24interface ISap extends @1.1::ISap {};
25};
diff --git a/tv/cec/1.0/types.hal b/tv/cec/1.0/types.hal
index a1853a31..c734c4d7 100644
--- a/tv/cec/1.0/types.hal
+++ b/tv/cec/1.0/types.hal
@@ -193,7 +193,7 @@ enum OptionKey : int32_t {
193 */ 193 */
194 SYSTEM_CEC_CONTROL = 3, 194 SYSTEM_CEC_CONTROL = 3,
195 195
196 /** Option 4 not used */ 196 /* Option 4 not used */
197}; 197};
198 198
199struct CecMessage { 199struct CecMessage {
diff --git a/usb/1.1/IUsb.hal b/usb/1.1/IUsb.hal
index 9cedea0c..606928bf 100644
--- a/usb/1.1/IUsb.hal
+++ b/usb/1.1/IUsb.hal
@@ -18,11 +18,9 @@ package android.hardware.usb@1.1;
18 18
19import android.hardware.usb@1.0; 19import android.hardware.usb@1.0;
20 20
21interface IUsb extends android.hardware.usb@1.0::IUsb { 21/*
22 /** 22 * The setCallback function in V1_0 is used to register the V1_1
23 * The setCallback function in V1_0 is used to register the V1_1 23 * IUsbCallback object as well. The implementation can use the
24 * IUsbCallback object as well. The implementation can use the 24 * castFrom method to cast the IUsbCallback object.
25 * castFrom method to cast the IUsbCallback object. 25 */
26 */ 26interface IUsb extends android.hardware.usb@1.0::IUsb {};
27};
28
diff --git a/wifi/1.0/IWifiP2pIface.hal b/wifi/1.0/IWifiP2pIface.hal
index 243748ff..b9085911 100644
--- a/wifi/1.0/IWifiP2pIface.hal
+++ b/wifi/1.0/IWifiP2pIface.hal
@@ -21,6 +21,4 @@ import IWifiIface;
21/** 21/**
22 * Interface used to represent a single NAN iface. 22 * Interface used to represent a single NAN iface.
23 */ 23 */
24interface IWifiP2pIface extends IWifiIface { 24interface IWifiP2pIface extends IWifiIface {};
25 /** TODO(rpius): Add methods to the interface. */
26};