Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: make
Change-Id: Ic77394d4d2e1ccedba3a28230d870c5d6108bd40
diff --git a/radio/1.0/IRadioIndication.hal b/radio/1.0/IRadioIndication.hal
index 0b95821..eb07226 100644
--- a/radio/1.0/IRadioIndication.hal
+++ b/radio/1.0/IRadioIndication.hal
@@ -16,11 +16,11 @@
package android.hardware.radio@1.0;
-/*
+/**
* Interface declaring unsolicited radio indications.
*/
interface IRadioIndication {
- /*
+ /**
* Indicates when radio state changes.
*
* @param type Type of radio indication
@@ -28,7 +28,7 @@
*/
oneway radioStateChanged(RadioIndicationType type, RadioState radioState);
- /*
+ /**
* Indicates when call state has changed.
* Callee must invoke IRadio.getCurrentCalls()
* Must be invoked on, for example,
@@ -41,7 +41,7 @@
*/
oneway callStateChanged(RadioIndicationType type);
- /*
+ /**
* Indicates when voice or data network state changed
* Callee must invoke IRadio.getVoiceRegistrationState(), IRadio.getDataRegistrationState(),
* and IRadio.getOperator()
@@ -50,7 +50,7 @@
*/
oneway networkStateChanged(RadioIndicationType type);
- /*
+ /**
* Indicates when new SMS is received.
* Callee must subsequently confirm the receipt of the SMS with a
* acknowledgeLastIncomingGsmSms()
@@ -64,7 +64,7 @@
*/
oneway newSms(RadioIndicationType type, vec<uint8_t> pdu);
- /*
+ /**
* Indicates when new SMS Status Report is received.
* Callee must subsequently confirm the receipt of the SMS with a
* acknowledgeLastIncomingGsmSms()
@@ -78,7 +78,7 @@
*/
oneway newSmsStatusReport(RadioIndicationType type, vec<uint8_t> pdu);
- /*
+ /**
* Indicates when new SMS has been stored on SIM card
*
* @param type Type of radio indication
@@ -86,7 +86,7 @@
*/
oneway newSmsOnSim(RadioIndicationType type, int32_t recordNumber);
- /*
+ /**
* Indicates when a new USSD message is received.
* The USSD session is assumed to persist if the type code is REQUEST, otherwise
* the current session (if any) is assumed to have terminated.
@@ -97,7 +97,7 @@
*/
oneway onUssd(RadioIndicationType type, UssdModeType modeType, string msg);
- /*
+ /**
* Indicates when radio has received a NITZ time message.
*
* @param type Type of radio indication
@@ -106,7 +106,7 @@
*/
oneway nitzTimeReceived(RadioIndicationType type, string nitzTime, uint64_t receivedTime);
- /*
+ /**
* Indicates current signal strength of the radio.
*
* @param type Type of radio indication
@@ -114,7 +114,7 @@
*/
oneway currentSignalStrength(RadioIndicationType type, SignalStrength signalStrength);
- /*
+ /**
* Indicates data call contexts have changed.
*
* @param type Type of radio indication
@@ -127,7 +127,7 @@
*/
oneway dataCallListChanged(RadioIndicationType type, vec<SetupDataCallResult> dcList);
- /*
+ /**
* Reports supplementary service related notification from the network.
*
* @param type Type of radio indication
@@ -135,14 +135,14 @@
*/
oneway suppSvcNotify(RadioIndicationType type, SuppSvcNotification suppSvc);
- /*
+ /**
* Indicates when STK session is terminated by SIM.
*
* @param type Type of radio indication
*/
oneway stkSessionEnd(RadioIndicationType type);
- /*
+ /**
* Indicates when SIM issue a STK proactive command to applications
*
* @param type Type of radio indication
@@ -151,7 +151,7 @@
*/
oneway stkProactiveCommand(RadioIndicationType type, string cmd);
- /*
+ /**
* Indicates when SIM notifies applcations some event happens.
*
* @param type Type of radio indication
@@ -162,7 +162,7 @@
*/
oneway stkEventNotify(RadioIndicationType type, string cmd);
- /*
+ /**
* Indicates when SIM wants application to setup a voice call.
*
* @param type Type of radio indication
@@ -170,7 +170,7 @@
*/
oneway stkCallSetup(RadioIndicationType type, int64_t timeout);
- /*
+ /**
* Indicates that SMS storage on the SIM is full. Sent when the network
* attempts to deliver a new SMS message. Messages cannot be saved on the
* SIM until space is freed. In particular, incoming Class 2 messages must not
@@ -180,7 +180,7 @@
*/
oneway simSmsStorageFull(RadioIndicationType type);
- /*
+ /**
* Indicates that file(s) on the SIM have been updated, or the SIM
* has been reinitialized.
* Note: If the SIM state changes as a result of the SIM refresh (eg,
@@ -192,7 +192,7 @@
*/
oneway simRefresh(RadioIndicationType type, SimRefreshResult refreshResult);
- /*
+ /**
* Ring indication for an incoming call (eg, RING or CRING event).
* There must be at least one callRing() at the beginning
* of a call and sending multiple is optional. If the system property
@@ -210,7 +210,7 @@
*/
oneway callRing(RadioIndicationType type, bool isGsm, CdmaSignalInfoRecord record);
- /*
+ /**
* Indicates that SIM state changes.
* Callee must invoke getIccCardStatus()
*
@@ -218,7 +218,7 @@
*/
oneway simStatusChanged(RadioIndicationType type);
- /*
+ /**
* Indicates when new CDMA SMS is received
* Callee must subsequently confirm the receipt of the SMS with
* acknowledgeLastIncomingCdmaSms()
@@ -230,7 +230,7 @@
*/
oneway cdmaNewSms(RadioIndicationType type, CdmaSmsMessage msg);
- /*
+ /**
* Indicates when new Broadcast SMS is received
*
* @param type Type of radio indication
@@ -243,7 +243,7 @@
*/
oneway newBroadcastSms(RadioIndicationType type, vec<uint8_t> data);
- /*
+ /**
* Indicates that SMS storage on the RUIM is full. Messages
* cannot be saved on the RUIM until space is freed.
*
@@ -251,7 +251,7 @@
*/
oneway cdmaRuimSmsStorageFull(RadioIndicationType type);
- /*
+ /**
* Indicates a restricted state change (eg, for Domain Specific Access Control).
* Radio must send this msg after radio off/on cycle no matter it is changed or not.
*
@@ -260,7 +260,7 @@
*/
oneway restrictedStateChanged(RadioIndicationType type, PhoneRestrictedState state);
- /*
+ /**
* Indicates that the radio system selection module has
* autonomously entered emergency callback mode.
*
@@ -268,7 +268,7 @@
*/
oneway enterEmergencyCallbackMode(RadioIndicationType type);
- /*
+ /**
* Indicates when CDMA radio receives a call waiting indication.
*
* @param type Type of radio indication
@@ -276,7 +276,7 @@
*/
oneway cdmaCallWaiting(RadioIndicationType type, CdmaCallWaiting callWaitingRecord);
- /*
+ /**
* Indicates when CDMA radio receives an update of the progress of an OTASP/OTAPA call.
*
* @param type Type of radio indication
@@ -284,7 +284,7 @@
*/
oneway cdmaOtaProvisionStatus(RadioIndicationType type, CdmaOtaProvisionStatus status);
- /*
+ /**
* Indicates when CDMA radio receives one or more info recs.
*
* @param type Type of radio indication
@@ -292,7 +292,7 @@
*/
oneway cdmaInfoRec(RadioIndicationType type, CdmaInformationRecords records);
- /*
+ /**
* Indicates that nework doesn't have in-band information, need to
* play out-band tone.
*
@@ -301,14 +301,14 @@
*/
oneway indicateRingbackTone(RadioIndicationType type, bool start);
- /*
+ /**
* Indicates that framework/application must reset the uplink mute state.
*
* @param type Type of radio indication
*/
oneway resendIncallMute(RadioIndicationType type);
- /*
+ /**
* Indicates when CDMA subscription source changed.
*
* @param type Type of radio indication
@@ -317,7 +317,7 @@
oneway cdmaSubscriptionSourceChanged(RadioIndicationType type,
CdmaSubscriptionSource cdmaSource);
- /*
+ /**
* Indicates when PRL (preferred roaming list) changes.
*
* @param type Type of radio indication
@@ -325,7 +325,7 @@
*/
oneway cdmaPrlChanged(RadioIndicationType type, int32_t version);
- /*
+ /**
* Indicates when Emergency Callback Mode Ends.
* Indicates that the radio system selection module has
* proactively exited emergency callback mode.
@@ -334,14 +334,14 @@
*/
oneway exitEmergencyCallbackMode(RadioIndicationType type);
- /*
+ /**
* Indicates the ril connects and returns the version
*
* @param type Type of radio indication
*/
oneway rilConnected(RadioIndicationType type);
- /*
+ /**
* Indicates that voice technology has changed. Responds with new rat.
*
* @param type Type of radio indication
@@ -349,7 +349,7 @@
*/
oneway voiceRadioTechChanged(RadioIndicationType type, RadioTechnology rat);
- /*
+ /**
* Same information as returned by getCellInfoList().
*
* @param type Type of radio indication
@@ -357,7 +357,7 @@
*/
oneway cellInfoList(RadioIndicationType type, vec<CellInfo> records);
- /*
+ /**
* Indicates when IMS registration state has changed.
* To get IMS registration state and IMS SMS format, callee needs to invoke
* getImsRegistrationState()
@@ -366,7 +366,7 @@
*/
oneway imsNetworkStateChanged(RadioIndicationType type);
- /*
+ /**
* Indicated when there is a change in subscription status.
* This event must be sent in the following scenarios
* - subscription readiness at modem, which was selected by telephony layer
@@ -378,7 +378,7 @@
*/
oneway subscriptionStatusChanged(RadioIndicationType type, bool activate);
- /*
+ /**
* Indicates when Single Radio Voice Call Continuity (SRVCC)
* progress state has changed
*
@@ -387,7 +387,7 @@
*/
oneway srvccStateNotify(RadioIndicationType type, SrvccState state);
- /*
+ /**
* Indicates when the hardware configuration associated with the RILd changes.
*
* @param type Type of radio indication
@@ -395,7 +395,7 @@
*/
oneway hardwareConfigChanged(RadioIndicationType type, vec<HardwareConfig> configs);
- /*
+ /**
* Sent when setRadioCapability() completes.
* Returns the phone radio capability exactly as
* getRadioCapability() and must be the
@@ -406,7 +406,7 @@
*/
oneway radioCapabilityIndication(RadioIndicationType type, RadioCapability rc);
- /*
+ /**
* Indicates when Supplementary service(SS) response is received when DIAL/USSD/SS is changed to
* SS by call control.
*
@@ -414,7 +414,7 @@
*/
oneway onSupplementaryServiceIndication(RadioIndicationType type, StkCcUnsolSsResult ss);
- /*
+ /**
* Indicates when there is an ALPHA from UICC during Call Control.
*
* @param type Type of radio indication
@@ -422,7 +422,7 @@
*/
oneway stkCallControlAlphaNotify(RadioIndicationType type, string alpha);
- /*
+ /**
* Indicates when there is an incoming Link Capacity Estimate (LCE) info report.
*
* @param type Type of radio indication
@@ -430,7 +430,7 @@
*/
oneway lceData(RadioIndicationType type, LceDataInfo lce);
- /*
+ /**
* Indicates when there is new Carrier PCO data received for a data call. Ideally
* only new data must be forwarded, though this is not required. Multiple
* boxes of carrier PCO data for a given call must result in a series of
@@ -441,7 +441,7 @@
*/
oneway pcoData(RadioIndicationType type, PcoDataInfo pco);
- /*
+ /**
* Indicates when there is a modem reset.
*
* When modem restarts, one of the following radio state transitions must happen