Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
diff --git a/tv/cec/1.0/IHdmiCec.hal b/tv/cec/1.0/IHdmiCec.hal
index e8db265..2840417 100644
--- a/tv/cec/1.0/IHdmiCec.hal
+++ b/tv/cec/1.0/IHdmiCec.hal
@@ -18,11 +18,11 @@
import IHdmiCecCallback;
-/*
+/**
* HDMI-CEC HAL interface definition.
*/
interface IHdmiCec {
- /*
+ /**
* Passes the logical address that must be used in this system.
*
* HAL must use it to configure the hardware so that the CEC commands
@@ -39,7 +39,7 @@
@callflow(next={"*"})
addLogicalAddress(CecLogicalAddress addr) generates (Result result);
- /*
+ /**
* Clears all the logical addresses.
*
* It is used when the system doesn't need to process CEC command any more,
@@ -50,7 +50,7 @@
@exit
clearLogicalAddress();
- /*
+ /**
* Gets the CEC physical address.
*
* The physical address depends on the topology of the network formed by
@@ -66,7 +66,7 @@
@callflow(next="*")
getPhysicalAddress() generates (Result result, uint16_t addr);
- /*
+ /**
* Transmits HDMI-CEC message to other HDMI device.
*
* The method must be designed to return in a certain amount of time and not
@@ -84,7 +84,7 @@
@callflow(next="*")
sendMessage(CecMessage message) generates (SendMessageResult result);
- /*
+ /**
* Sets a callback that HDMI-CEC HAL must later use for incoming CEC
* messages or internal HDMI events.
*
@@ -95,7 +95,7 @@
@entry
setCallback(IHdmiCecCallback callback);
- /*
+ /**
* Returns the CEC version supported by underlying hardware.
*
* @return version the CEC version supported by underlying hardware.
@@ -103,7 +103,7 @@
@callflow(next={"*"})
getCecVersion() generates (int32_t version);
- /*
+ /**
* Gets the identifier of the vendor.
*
* @return vendorId Identifier of the vendor that is the 24-bit unique
@@ -113,7 +113,7 @@
@callflow(next={"*"})
getVendorId() generates (uint32_t vendorId);
- /*
+ /**
* Gets the hdmi port information of underlying hardware.
*
* @return infos The list of HDMI port information
@@ -121,7 +121,7 @@
@callflow(next={"*"})
getPortInfo() generates (vec<HdmiPortInfo> infos);
- /*
+ /**
* Sets flags controlling the way HDMI-CEC service works down to HAL
* implementation. Those flags must be used in case the feature needs update
* in HAL itself, firmware or microcontroller.
@@ -132,7 +132,7 @@
@callflow(next="*")
setOption(OptionKey key, bool value);
- /*
+ /**
* Passes the updated language information of Android system. Contains
* three-letter code as defined in ISO/FDIS 639-2. Must be used for HAL to
* respond to <Get Menu Language> while in standby mode.
@@ -143,7 +143,7 @@
@callflow(next="*")
setLanguage(string language);
- /*
+ /**
* Configures ARC circuit in the hardware logic to start or stop the
* feature.
*
@@ -154,7 +154,7 @@
@callflow(next="*")
enableAudioReturnChannel(int32_t portId, bool enable);
- /*
+ /**
* Gets the connection status of the specified port.
*
* @param portId Port id to be inspected for the connection status.
diff --git a/tv/cec/1.0/IHdmiCecCallback.hal b/tv/cec/1.0/IHdmiCecCallback.hal
index 4a9d28f..754d19f 100644
--- a/tv/cec/1.0/IHdmiCecCallback.hal
+++ b/tv/cec/1.0/IHdmiCecCallback.hal
@@ -17,13 +17,13 @@
package android.hardware.tv.cec@1.0;
interface IHdmiCecCallback {
- /*
+ /**
* The callback function that must be called by HAL implementation to notify
* the system of new CEC message arrival.
*/
oneway onCecMessage(CecMessage message);
- /*
+ /**
* The callback function that must be called by HAL implementation to notify
* the system of new hotplug event.
*/
diff --git a/tv/cec/1.0/types.hal b/tv/cec/1.0/types.hal
index ec2e373..a1853a3 100644
--- a/tv/cec/1.0/types.hal
+++ b/tv/cec/1.0/types.hal
@@ -48,7 +48,7 @@
BROADCAST = 15, // as Destination address
};
-/*
+/**
* HDMI CEC message types. The assigned values represent opcode used in CEC
* frame as specified in CEC Table 8-26 of the CEC Spec 1.4b.
*/
@@ -123,7 +123,7 @@
ABORT = 0xFF,
};
-/*
+/**
* Operand description [Abort Reason]
*/
enum AbortReason : int32_t {
@@ -144,7 +144,7 @@
FAILURE_BUSY = 5,
};
-/*
+/**
* error code used for send_message.
*/
enum SendMessageResult : int32_t {
@@ -154,7 +154,7 @@
FAIL = 3,
};
-/*
+/**
* HDMI port type.
*/
enum HdmiPortType : int32_t {
@@ -162,24 +162,27 @@
OUTPUT = 1,
};
-/*
+/**
* Options used for IHdmiCec.setOption()
*/
enum OptionKey : int32_t {
- /* When set to false, HAL does not wake up the system upon receiving <Image
+ /**
+ * When set to false, HAL does not wake up the system upon receiving <Image
* View On> or <Text View On>. Used when user changes the TV settings to
* disable the auto TV on functionality.
* True by default.
*/
WAKEUP = 1,
- /* When set to false, all the CEC commands are discarded. Used when user
+ /**
+ * When set to false, all the CEC commands are discarded. Used when user
* changes the TV settings to disable CEC functionality.
* True by default.
*/
ENABLE_CEC = 2,
- /* Setting this flag to false means Android system must stop handling CEC
+ /**
+ * Setting this flag to false means Android system must stop handling CEC
* service and yield the control over to the microprocessor that is powered
* on through the standby mode. When set to true, the system must gain the
* control over, hence telling the microprocessor to stop handling the CEC
@@ -190,17 +193,18 @@
*/
SYSTEM_CEC_CONTROL = 3,
- /* Option 4 not used */
+ /** Option 4 not used */
};
struct CecMessage {
- /* logical address of sender */
+ /** logical address of sender */
CecLogicalAddress initiator;
- /* logical address of receiver */
+ /** logical address of receiver */
CecLogicalAddress destination;
- /* The maximum size of body is 15 (MaxLength::MESSAGE_BODY) as specified in
+ /**
+ * The maximum size of body is 15 (MaxLength::MESSAGE_BODY) as specified in
* the section 6 of the CEC Spec 1.4b. Overflowed data must be ignored. */
vec<uint8_t> body;
};
@@ -210,7 +214,7 @@
uint32_t portId;
};
-/*
+/**
* HDMI port descriptor
*/
struct HdmiPortInfo {
diff --git a/tv/input/1.0/ITvInput.hal b/tv/input/1.0/ITvInput.hal
index 43de276..95aff21 100644
--- a/tv/input/1.0/ITvInput.hal
+++ b/tv/input/1.0/ITvInput.hal
@@ -19,7 +19,7 @@
import ITvInputCallback;
interface ITvInput {
- /*
+ /**
* Sets a callback for events.
*
* Note that initially no device is available in the client side, so the
@@ -33,7 +33,7 @@
@callflow(next={"getStreamConfigurations"})
setCallback(ITvInputCallback callback);
- /*
+ /**
* Gets stream configurations for a specific device.
*
* The configs object is valid only until the next
@@ -48,7 +48,7 @@
getStreamConfigurations(int32_t deviceId)
generates (Result result, vec<TvStreamConfig> configurations);
- /*
+ /**
* Opens a specific stream in a device.
*
* @param deviceId Device ID for the steam to open.
@@ -65,7 +65,7 @@
openStream(int32_t deviceId, int32_t streamId)
generates (Result result, handle sidebandStream);
- /*
+ /**
* Closes a specific stream in a device.
*
* @param deviceId Device ID for the steam to open.
diff --git a/tv/input/1.0/ITvInputCallback.hal b/tv/input/1.0/ITvInputCallback.hal
index f2f07a0..6d88c5b 100644
--- a/tv/input/1.0/ITvInputCallback.hal
+++ b/tv/input/1.0/ITvInputCallback.hal
@@ -17,7 +17,7 @@
package android.hardware.tv.input@1.0;
interface ITvInputCallback {
- /*
+ /**
* Notifies the client that an event has occured. For possible event types,
* check TvInputEventType.
*
diff --git a/tv/input/1.0/types.hal b/tv/input/1.0/types.hal
index 60a3b7b..55dd6c0 100644
--- a/tv/input/1.0/types.hal
+++ b/tv/input/1.0/types.hal
@@ -26,7 +26,7 @@
INVALID_STATE,
};
-/* Type of physical TV input. */
+/** Type of physical TV input. */
@export(name="", value_prefix="TV_INPUT_TYPE_")
enum TvInputType : int32_t {
OTHER = 1, // Generic hardware.
@@ -41,7 +41,7 @@
DISPLAY_PORT = 10,
};
-/*
+/**
* Status of cable connection.
* This status is for devices having availability to detect the cable in a mechanical way,
* regardless of whether the connected external device is electrically on or not.
@@ -67,7 +67,7 @@
@export(name="", value_prefix="EVENT_")
enum TvInputEventType : int32_t {
- /*
+ /**
* Hardware notifies the framework that a device is available.
*
* Note that DEVICE_AVAILABLE and DEVICE_UNAVAILABLE events do not represent
@@ -89,7 +89,7 @@
*/
DEVICE_AVAILABLE = 1,
- /*
+ /**
* Hardware notifies the framework that a device is unavailable.
*
* HAL implementation must generate this event when a device registered
@@ -104,7 +104,7 @@
*/
DEVICE_UNAVAILABLE = 2,
- /*
+ /**
* Stream configurations are changed. Client must regard all open streams
* at the specific device are closed, and must call
* getStreamConfigurations() again, opening some of them if necessary.
@@ -126,7 +126,7 @@
struct TvInputEvent {
TvInputEventType type;
- /*
+ /**
* DEVICE_AVAILABLE: all fields are relevant.
* DEVICE_UNAVAILABLE: only deviceId is relevant.
* STREAM_CONFIGURATIONS_CHANGED: only deviceId is relevant.