From 913c071391e096bd6b77510b285d746ee97c28ed Mon Sep 17 00:00:00 2001 From: Steven Moreland Date: Thu, 17 May 2018 14:32:17 -0700 Subject: [PATCH] Update comments for doc comments. Doc comments look like "/** ... */" and they can only be in certain places. Bug: 79865343 Test: m Change-Id: Ic15c08ff7dc6e4f9827c1dbe7f7236c11a572ec1 Merged-In: Ic15c08ff7dc6e4f9827c1dbe7f7236c11a572ec1 --- broadcastradio/1.0/types.hal | 6 ++++-- current.txt | 13 ++++++++++++ .../1.0/IGraphicBufferProducer.hal | 2 +- graphics/composer/2.1/IComposerClient.hal | 4 ++-- graphics/composer/2.1/types.hal | 18 ++++++++--------- graphics/mapper/2.0/IMapper.hal | 4 ++-- graphics/mapper/2.0/types.hal | 12 +++++------ keymaster/3.0/types.hal | 20 +++++++++---------- radio/1.1/ISap.hal | 9 ++++----- radio/1.2/ISap.hal | 9 ++++----- tv/cec/1.0/types.hal | 2 +- usb/1.1/IUsb.hal | 14 ++++++------- wifi/1.0/IWifiP2pIface.hal | 4 +--- 13 files changed, 63 insertions(+), 54 deletions(-) diff --git a/broadcastradio/1.0/types.hal b/broadcastradio/1.0/types.hal index 8c3ec119d3..259c7c9e05 100644 --- a/broadcastradio/1.0/types.hal +++ b/broadcastradio/1.0/types.hal @@ -136,7 +136,8 @@ struct Properties { uint32_t numAudioSources; /** the hardware supports capture of audio source from audio HAL */ bool supportsCapture; - vec bands; /** band descriptors */ + /** band descriptors */ + vec bands; }; enum MetadataType : int32_t { @@ -229,6 +230,7 @@ struct ProgramInfo { */ uint32_t signalStrength; - vec metadata; /** Metadata: PTY, song title etc. */ + /** Metadata: PTY, song title etc. */ + vec metadata; }; diff --git a/current.txt b/current.txt index 14cdaa0b99..28f0f992b0 100644 --- a/current.txt +++ b/current.txt @@ -251,3 +251,16 @@ c8bc853546dd55584611def2a9fa1d99f657e3366c976d2f60fe6b8aa6d2cb87 android.hardwar 12e8dca4ab7d8aadd0ef8f1b438021938e2396139e85db2ed65783b08800aa52 android.hardware.neuralnetworks@1.0::IExecutionCallback 18e6885e184fe48401c2c53f1d1b8bfb07240f40c81ae6b9d2e336fca6efdbb7 android.hardware.neuralnetworks@1.0::types +# Documentation fixups for b/78135149 +9e7a0b650d0e461ece2cfec0e1072abf8676f592b41a7fb48f01e88fc3c8f780 android.hardware.broadcastradio@1.0::types +190ea4898809de6cf379afe318f5fa9564686157b24d9a2d7f5698b0c977d8b2 android.hardware.graphics.bufferqueue@1.0::IGraphicBufferProducer +25892789b50eb673506b6c5a2cdab5d9aa428d41608aab10280cc898538b524a android.hardware.graphics.composer@2.1::IComposerClient +e205dd30f5ff99445b706a901de8ebc46c379e9d7c1921d6a327ed2082cfa83d android.hardware.graphics.composer@2.1::types +a46251718abfada458dc64c41ce94915757bf6c87cfa2d9e99cfb01fa8e32331 android.hardware.graphics.mapper@2.0::IMapper +bd33ac23c57b4a07632691d2191bc2c93930f57e62f4ccf459748fdaa5c0f480 android.hardware.graphics.mapper@2.0::types +ad8a28ca3a5549fb9bc24cf5f80ac8f660cc27be885210d76266780aa52ddb8d android.hardware.keymaster@3.0::types +f96cbc59dfe16c8d0c2a7e06db24d8738a6328b6e90f7b8e1640ea2b4600debd android.hardware.radio@1.1::ISap +2d86929794795e5c70f4fdb5073485fd05835c9c6f496116687c3d9f32e6df3e android.hardware.radio@1.2::ISap +905a4af79c8329b39d8b11b08f015137216bb078b427b6986f32884a04bc1bec android.hardware.tv.cec@1.0::types +aebcd9ff2da05c9d4c439916f40dfd219ba7629919007cb981ebf150064b4f82 android.hardware.usb@1.1::IUsb +e29fb1941b40a990676f8e9c676a38761defd890b81a9c034608eb7ba6496023 android.hardware.wifi@1.0::IWifiP2pIface diff --git a/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal b/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal index 87bb814ab5..c59a16ccbd 100644 --- a/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal +++ b/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal @@ -546,7 +546,7 @@ interface IGraphicBufferProducer { */ disconnect( int32_t api, - DisconnectMode mode /** = DisconnectMode::API */ + DisconnectMode mode /* = DisconnectMode::API */ ) generates ( Status status ); diff --git a/graphics/composer/2.1/IComposerClient.hal b/graphics/composer/2.1/IComposerClient.hal index f2ff932f18..5ad46f0113 100644 --- a/graphics/composer/2.1/IComposerClient.hal +++ b/graphics/composer/2.1/IComposerClient.hal @@ -1138,7 +1138,7 @@ interface IComposerClient { SET_LAYER_Z_ORDER = 0x40a << OPCODE_SHIFT, SET_PRESENT_OR_VALIDATE_DISPLAY_RESULT = 0x40b << OPCODE_SHIFT, - /** 0x800 - 0xfff are reserved for vendor extensions */ - /** 0x1000 - 0xffff are reserved */ + /* 0x800 - 0xfff are reserved for vendor extensions */ + /* 0x1000 - 0xffff are reserved */ }; }; diff --git a/graphics/composer/2.1/types.hal b/graphics/composer/2.1/types.hal index 9f0dd8bc4f..eb0a73bb6a 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; /** Return codes from all functions. */ enum Error : int32_t { - NONE = 0, /** no error */ - BAD_CONFIG = 1, /** invalid Config */ - BAD_DISPLAY = 2, /** invalid Display */ - BAD_LAYER = 3, /** invalid Layer */ - BAD_PARAMETER = 4, /** invalid width, height, etc. */ - /** 5 is reserved */ - NO_RESOURCES = 6, /** temporary failure due to resource contention */ - NOT_VALIDATED = 7, /** validateDisplay has not been called */ - UNSUPPORTED = 8, /** permanent failure */ + NONE = 0, /* no error */ + BAD_CONFIG = 1, /* invalid Config */ + BAD_DISPLAY = 2, /* invalid Display */ + BAD_LAYER = 3, /* invalid Layer */ + BAD_PARAMETER = 4, /* invalid width, height, etc. */ + /* 5 is reserved */ + NO_RESOURCES = 6, /* temporary failure due to resource contention */ + NOT_VALIDATED = 7, /* validateDisplay has not been called */ + UNSUPPORTED = 8, /* permanent failure */ }; typedef uint32_t Config; diff --git a/graphics/mapper/2.0/IMapper.hal b/graphics/mapper/2.0/IMapper.hal index 4ee206bcdc..45661357af 100644 --- a/graphics/mapper/2.0/IMapper.hal +++ b/graphics/mapper/2.0/IMapper.hal @@ -155,7 +155,7 @@ interface IMapper { * @param cpuUsage specifies one or more CPU usage flags to request. * @param accessRegion is the portion of the buffer that the client * intends to access. - * @param acquireFence, when non-empty, is a handle containing a file + * @param acquireFence when non-empty, is a handle containing a file * descriptor referring to a sync fence object, which will be * signaled when it is safe for the mapper to lock the buffer. If * it is already safe to lock, acquireFence is empty. @@ -191,7 +191,7 @@ interface IMapper { * @param cpuUsage specifies one or more CPU usage flags to request. * @param accessRegion is the portion of the buffer that the client * intends to access. - * @param acquireFence, when non-empty, is a handle containing a file + * @param acquireFence when non-empty, is a handle containing a file * descriptor referring to a sync fence object, which will be * signaled when it is safe for the mapper to lock the buffer. If * 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 e9b2f3a76c..2291f70085 100644 --- a/graphics/mapper/2.0/types.hal +++ b/graphics/mapper/2.0/types.hal @@ -17,14 +17,14 @@ package android.hardware.graphics.mapper@2.0; enum Error : int32_t { - NONE = 0, /** no error */ - BAD_DESCRIPTOR = 1, /** invalid BufferDescriptor */ - BAD_BUFFER = 2, /** invalid buffer handle */ - BAD_VALUE = 3, /** invalid width, height, etc. */ + NONE = 0, /* no error */ + BAD_DESCRIPTOR = 1, /* invalid BufferDescriptor */ + BAD_BUFFER = 2, /* invalid buffer handle */ + BAD_VALUE = 3, /* invalid width, height, etc. */ /* 4 is reserved */ - NO_RESOURCES = 5, /** temporary failure due to resource contention */ + NO_RESOURCES = 5, /* temporary failure due to resource contention */ /* 6 is reserved */ - UNSUPPORTED = 7, /** permanent failure */ + UNSUPPORTED = 7, /* permanent failure */ }; /** diff --git a/keymaster/3.0/types.hal b/keymaster/3.0/types.hal index 6dad23e4d3..72f7d47347 100644 --- a/keymaster/3.0/types.hal +++ b/keymaster/3.0/types.hal @@ -17,17 +17,17 @@ package android.hardware.keymaster@3.0; enum TagType : uint32_t { - INVALID = 0 << 28, /** Invalid type, used to designate a tag as uninitialized */ + INVALID = 0 << 28, /* Invalid type, used to designate a tag as uninitialized */ ENUM = 1 << 28, - ENUM_REP = 2 << 28, /** Repeatable enumeration value. */ + ENUM_REP = 2 << 28, /* Repeatable enumeration value. */ UINT = 3 << 28, - UINT_REP = 4 << 28, /** Repeatable integer value */ + UINT_REP = 4 << 28, /* Repeatable integer value */ ULONG = 5 << 28, DATE = 6 << 28, BOOL = 7 << 28, BIGNUM = 8 << 28, BYTES = 9 << 28, - ULONG_REP = 10 << 28, /** Repeatable long value */ + ULONG_REP = 10 << 28, /* Repeatable long value */ }; enum Tag : uint32_t { @@ -254,12 +254,12 @@ enum KeyBlobUsageRequirements : uint32_t { * Possible purposes of a key (or pair). */ enum KeyPurpose : uint32_t { - ENCRYPT = 0, /** Usable with RSA, EC and AES keys. */ - DECRYPT = 1, /** Usable with RSA, EC and AES keys. */ - SIGN = 2, /** Usable with RSA, EC and HMAC keys. */ - VERIFY = 3, /** Usable with RSA, EC and HMAC keys. */ - DERIVE_KEY = 4, /** Usable with EC keys. */ - WRAP_KEY = 5, /** Usable with wrapping keys. */ + ENCRYPT = 0, /* Usable with RSA, EC and AES keys. */ + DECRYPT = 1, /* Usable with RSA, EC and AES keys. */ + SIGN = 2, /* Usable with RSA, EC and HMAC keys. */ + VERIFY = 3, /* Usable with RSA, EC and HMAC keys. */ + DERIVE_KEY = 4, /* Usable with EC keys. */ + WRAP_KEY = 5, /* Usable with wrapping keys. */ }; /** diff --git a/radio/1.1/ISap.hal b/radio/1.1/ISap.hal index edcf176aac..0cabccc185 100644 --- a/radio/1.1/ISap.hal +++ b/radio/1.1/ISap.hal @@ -18,8 +18,7 @@ package android.hardware.radio@1.1; import @1.0::ISap; -interface ISap extends @1.0::ISap { - /** - * Empty top level interface. - */ -}; +/** + * Empty top level interface. + */ +interface ISap extends @1.0::ISap {}; diff --git a/radio/1.2/ISap.hal b/radio/1.2/ISap.hal index 757027ce02..65f9b848b1 100644 --- a/radio/1.2/ISap.hal +++ b/radio/1.2/ISap.hal @@ -18,8 +18,7 @@ package android.hardware.radio@1.2; import @1.1::ISap; -interface ISap extends @1.1::ISap { - /** - * Empty top level interface. - */ -}; +/** + * Empty top level interface. + */ +interface ISap extends @1.1::ISap {}; diff --git a/tv/cec/1.0/types.hal b/tv/cec/1.0/types.hal index a1853a31cc..c734c4d7ad 100644 --- a/tv/cec/1.0/types.hal +++ b/tv/cec/1.0/types.hal @@ -193,7 +193,7 @@ enum OptionKey : int32_t { */ SYSTEM_CEC_CONTROL = 3, - /** Option 4 not used */ + /* Option 4 not used */ }; struct CecMessage { diff --git a/usb/1.1/IUsb.hal b/usb/1.1/IUsb.hal index 9cedea0c69..606928bf98 100644 --- a/usb/1.1/IUsb.hal +++ b/usb/1.1/IUsb.hal @@ -18,11 +18,9 @@ package android.hardware.usb@1.1; import android.hardware.usb@1.0; -interface IUsb extends android.hardware.usb@1.0::IUsb { - /** - * The setCallback function in V1_0 is used to register the V1_1 - * IUsbCallback object as well. The implementation can use the - * castFrom method to cast the IUsbCallback object. - */ -}; - +/* + * The setCallback function in V1_0 is used to register the V1_1 + * IUsbCallback object as well. The implementation can use the + * castFrom method to cast the IUsbCallback object. + */ +interface IUsb extends android.hardware.usb@1.0::IUsb {}; diff --git a/wifi/1.0/IWifiP2pIface.hal b/wifi/1.0/IWifiP2pIface.hal index 243748ffc0..b908591128 100644 --- a/wifi/1.0/IWifiP2pIface.hal +++ b/wifi/1.0/IWifiP2pIface.hal @@ -21,6 +21,4 @@ import IWifiIface; /** * Interface used to represent a single NAN iface. */ -interface IWifiP2pIface extends IWifiIface { - /** TODO(rpius): Add methods to the interface. */ -}; +interface IWifiP2pIface extends IWifiIface {};