Evolution-x/hardware_interfaces
1
0
Fork 0
mirror of https://github.com/Evolution-X/hardware_interfaces synced 2026-02-01 05:49:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update comments for doc comments.

Browse Source 
Doc comments look like "/** ... */" and they
can only be in certain places.

Bug: 79865343
Test: m
Change-Id: Ic15c08ff7dc6e4f9827c1dbe7f7236c11a572ec1
Merged-In: Ic15c08ff7dc6e4f9827c1dbe7f7236c11a572ec1
This commit is contained in:
Steven Moreland
2018-05-17 14:32:17 -07:00
parent 867726a9cb
commit 913c071391
13 changed files with 63 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
broadcastradio/1.0/types.hal
View File

@@ -136,7 +136,8 @@ struct Properties {
uint32_t numAudioSources;
/** the hardware supports capture of audio source from audio HAL */
bool supportsCapture;
vec<BandConfig> bands; /** band descriptors */
/** band descriptors */
vec<BandConfig> bands;
};
enum MetadataType : int32_t {
@@ -229,6 +230,7 @@ struct ProgramInfo {
*/
uint32_t signalStrength;
vec<MetaData> metadata; /** Metadata: PTY, song title etc. */
/** Metadata: PTY, song title etc. */
vec<MetaData> metadata;
};

13
current.txt
View File

@@ -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

2
graphics/bufferqueue/1.0/IGraphicBufferProducer.hal
View File

@@ -546,7 +546,7 @@ interface IGraphicBufferProducer {
*/
disconnect(
int32_t api,
DisconnectMode mode /** = DisconnectMode::API */
DisconnectMode mode /* = DisconnectMode::API */
) generates (
Status status
);

4
graphics/composer/2.1/IComposerClient.hal
View File

@@ -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 */
};
};

18
graphics/composer/2.1/types.hal
View File

@@ -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;

4
graphics/mapper/2.0/IMapper.hal
View File

@@ -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.

12
graphics/mapper/2.0/types.hal
View File

@@ -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 */
};
/**

20
keymaster/3.0/types.hal
View File

@@ -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. */
};
/**

9
radio/1.1/ISap.hal
View File

@@ -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 {};

9
radio/1.2/ISap.hal
View File

@@ -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 {};

2
tv/cec/1.0/types.hal
View File

@@ -193,7 +193,7 @@ enum OptionKey : int32_t {
*/
SYSTEM_CEC_CONTROL = 3,
/** Option 4 not used */
/* Option 4 not used */
};
struct CecMessage {

14
usb/1.1/IUsb.hal
View File

@@ -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 {};

4
wifi/1.0/IWifiP2pIface.hal
View File

@@ -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 {};