Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
diff --git a/usb/1.0/IUsb.hal b/usb/1.0/IUsb.hal
index 965326a..f464379 100644
--- a/usb/1.0/IUsb.hal
+++ b/usb/1.0/IUsb.hal
@@ -19,7 +19,7 @@
import IUsbCallback;
interface IUsb {
- /*
+ /**
* This function is used to change the port role of a specific port.
* For example, when PD_SWAP or PR_SWAP is supported.
* This is function is asynchronous. The status of the role switch
@@ -31,7 +31,7 @@
*/
oneway switchRole(string portName, PortRole role);
- /*
+ /**
* This function is used to register a callback function which is
* called by the HAL whenever there is a change in the port state.
* i.e. DATA_ROLE, POWER_ROLE or MODE.
@@ -44,7 +44,7 @@
*/
oneway setCallback(IUsbCallback callback);
- /*
+ /**
* This functions is used to request the hal for the current status
* status of the Type-C ports. This method is async/oneway. The result of the
* query would be sent through the IUsbCallback object's notifyRoleSwitchStatus
diff --git a/usb/1.0/IUsbCallback.hal b/usb/1.0/IUsbCallback.hal
index b665ba3..fd91cbf 100644
--- a/usb/1.0/IUsbCallback.hal
+++ b/usb/1.0/IUsbCallback.hal
@@ -16,13 +16,13 @@
package android.hardware.usb@1.0;
-/*
+/**
* Callback object used for all the IUsb async methods which expects a result.
* Caller is expected to register the callback object using setCallback method
* to receive updates on the PortStatus.
*/
interface IUsbCallback {
- /*
+ /**
* Used to convey the current port status to the caller.
* Called either when PortState changes due to the port partner (or)
* when caller requested for the PortStatus update through queryPortStatus.
@@ -34,7 +34,7 @@
*/
oneway notifyPortStatusChange(vec<PortStatus> currentPortStatus, Status retval);
- /*
+ /**
* Used to notify the result of the switchRole call to the caller.
*
* @param portName name of the port for which the roleswap is requested.
diff --git a/usb/1.0/types.hal b/usb/1.0/types.hal
index 17cd8c7..302616e 100644
--- a/usb/1.0/types.hal
+++ b/usb/1.0/types.hal
@@ -19,42 +19,42 @@
enum Status : uint32_t {
SUCCESS = 0,
- /*
+ /**
* error value when the HAL operation fails for reasons not listed here.
*/
ERROR = 1,
- /*
+ /**
* error value returned when input argument is invalid.
*/
INVALID_ARGUMENT = 2,
- /*
+ /**
* error value returned when role string is unrecognized.
*/
UNRECOGNIZED_ROLE = 3,
};
-/*
+/**
* Denotes the Port role type.
* Passed as an argument for functions used to query or change port roles.
*/
enum PortRoleType : uint32_t {
- /*
+ /**
* Denotes the data role of the port.
* The port can either be a "host" or a "device" for data.
* This maps to the PortDataRole enum.
*/
DATA_ROLE = 0,
- /*
+ /**
* Denotes the power role of the port.
* The port can either be a "source" or "sink" for power.
* This maps to PortPowerRole enum.
*/
POWER_ROLE = 1,
- /*
+ /**
* USB ports can be a pure DFP port which can only act
* as a host. A UFP port which can only act as a device.
* Or a dual role ports which can either can as a host or
@@ -65,19 +65,19 @@
@export
enum PortDataRole : uint32_t {
- /*
+ /**
* Indicates that the port does not have a data role.
* In case of DRP, the current data role of the port is only resolved
* when the type-c handshake happens.
*/
NONE = 0,
- /*
+ /**
* Indicates that the port is acting as a host for data.
*/
HOST = 1,
- /*
+ /**
* Indicated that the port is acting as a device for data.
*/
DEVICE = 2,
@@ -87,19 +87,19 @@
@export
enum PortPowerRole : uint32_t {
- /*
+ /**
* Indicates that the port does not have a power role.
* In case of DRP, the current power role of the port is only resolved
* when the type-c handshake happens.
*/
NONE = 0,
- /*
+ /**
* Indicates that the port is supplying power to the other port.
*/
SOURCE = 1,
- /*
+ /**
* Indicates that the port is sinking power from the other port.
*/
SINK = 2,
@@ -109,23 +109,23 @@
@export
enum PortMode : uint32_t {
- /*
+ /**
* Indicates that the port does not have a mode.
* In case of DRP, the current mode of the port is only resolved
* when the type-c handshake happens.
*/
NONE = 0,
- /*
+ /**
* Indicates that port can only act as device for data and sink for power.
*/
UFP = 1,
- /*
+ /**
* Indicates the port can only act as host for data and source for power.
*/
DFP = 2,
- /*
+ /**
* Indicates can either act as UFP or DFP at a given point of time.
*/
DRP = 3,
@@ -133,17 +133,17 @@
NUM_MODES = 4,
};
-/*
+/**
* Used as a container to send port role information.
*/
struct PortRole {
- /*
+ /**
* Indicates the type of Port Role.
* Maps to the PortRoleType enum.
*/
PortRoleType type;
- /*
+ /**
* when type is HAL_USB_DATA_ROLE pass values from enum PortDataRole.
* when type is HAL_USB_POWER_ROLE pass values from enum PortPowerRole.
* when type is HAL_USB_MODE pass values from enum PortMode.
@@ -151,40 +151,40 @@
uint32_t role;
};
-/*
+/**
* Used as the container to report data back to the caller.
* Represents the current connection status of a single USB port.
*/
struct PortStatus {
- /*
+ /**
* Name of the port.
* Used as the port's id by the caller.
*/
string portName;
- /*
+ /**
* Data role of the port.
*/
PortDataRole currentDataRole;
- /*
+ /**
* Power Role of thte port.
*/
PortPowerRole currentPowerRole;
- /*
+ /**
* Mode in which the port is connected.
* Can be UFP or DFP.
*/
PortMode currentMode;
- /*
+ /**
* True indicates that the port's mode can
* be changed. False otherwise.
*/
bool canChangeMode;
- /*
+ /**
* True indicates that the port's data role
* can be changed. False otherwise.
* For example, true if Type-C PD PD_SWAP
@@ -192,7 +192,7 @@
*/
bool canChangeDataRole;
- /*
+ /**
* True indicates that the port's power role
* can be changed. False otherwise.
* For example, true if Type-C PD PR_SWAP
@@ -200,7 +200,7 @@
*/
bool canChangePowerRole;
- /*
+ /**
* Identifies the type of the local port.
*
* UFP - Indicates that port can only act as device for