Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
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.