Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
diff --git a/broadcastradio/1.0/IBroadcastRadio.hal b/broadcastradio/1.0/IBroadcastRadio.hal
index c7fe62d..f599b10 100644
--- a/broadcastradio/1.0/IBroadcastRadio.hal
+++ b/broadcastradio/1.0/IBroadcastRadio.hal
@@ -21,7 +21,7 @@
interface IBroadcastRadio {
- /*
+ /**
* Retrieve implementation properties.
* @return result Operation completion status: OK in case of success,
* NOT_INITIALIZED in case of initialization error.
@@ -30,7 +30,7 @@
*/
getProperties() generates (Result result, Properties properties);
- /*
+ /**
* Open a tuner interface for the requested configuration.
* If no other tuner is opened, this will power on the radio hardware.
* The hardware must be powered down when all tuner interface are released.
diff --git a/broadcastradio/1.0/IBroadcastRadioFactory.hal b/broadcastradio/1.0/IBroadcastRadioFactory.hal
index 82a97c4..ae82b07 100644
--- a/broadcastradio/1.0/IBroadcastRadioFactory.hal
+++ b/broadcastradio/1.0/IBroadcastRadioFactory.hal
@@ -20,7 +20,7 @@
interface IBroadcastRadioFactory {
- /*
+ /**
* Connects to a broadcast radio HAL module for a given class
* (AM/FM, Satellite, DAB).
*
diff --git a/broadcastradio/1.0/ITuner.hal b/broadcastradio/1.0/ITuner.hal
index ae4b284..abbbd7a 100644
--- a/broadcastradio/1.0/ITuner.hal
+++ b/broadcastradio/1.0/ITuner.hal
@@ -20,7 +20,7 @@
interface ITuner {
- /*
+ /**
* Apply current radio band configuration (band, range, channel spacing...).
* Automatically cancels pending scan, step or tune.
* ITunerCallback.configChange() method MUST be called once the
@@ -33,7 +33,7 @@
*/
setConfiguration(BandConfig config) generates(Result result);
- /*
+ /**
* Retrieve current radio band configuration.
* @return result OK if valid configuration is returned,
* NOT_INITIALIZED in case of initialization error.
@@ -41,7 +41,7 @@
*/
getConfiguration() generates(Result result, BandConfig config);
- /*
+ /**
* Start scanning up to next valid station.
* Shall be called only when a valid configuration has been applied.
* Automatically cancels pending scan, step or tune.
@@ -57,7 +57,7 @@
*/
scan(Direction direction, bool skipSubChannel) generates(Result result);
- /*
+ /**
* Move one channel spacing up or down.
* Must be called when a valid configuration has been applied.
* Automatically cancels pending scan, step or tune.
@@ -73,7 +73,7 @@
*/
step(Direction direction, bool skipSubChannel) generates(Result result);
- /*
+ /**
* Tune to specified channel.
* Must be called when a valid configuration has been applied.
* Automatically cancels pending scan, step or tune.
@@ -91,7 +91,7 @@
*/
tune(uint32_t channel, uint32_t subChannel) generates(Result result);
- /*
+ /**
* Cancel a scan, step or tune operation.
* Shall be called only while a scan, step or tune operation is pending.
* ITunerCallback.tuneComplete() MUST NOT be sent by the HAL.
@@ -101,7 +101,7 @@
*/
cancel() generates(Result result);
- /*
+ /**
* Retrieve current station information.
* @return result OK if scan successfully started
* NOT_INITIALIZED if another error occurs
diff --git a/broadcastradio/1.0/ITunerCallback.hal b/broadcastradio/1.0/ITunerCallback.hal
index a7e1260..0966ff4 100644
--- a/broadcastradio/1.0/ITunerCallback.hal
+++ b/broadcastradio/1.0/ITunerCallback.hal
@@ -19,13 +19,13 @@
interface ITunerCallback {
- /*
+ /**
* Method called by the HAL when a HW failure occurs.
* The framework MUST close the ITuner interface and open a new one.
*/
oneway hardwareFailure();
- /*
+ /**
* Method called by the HAL when a new configuration is applied
* in response to IDevice.openTuner() or ITuner.setConfiguration().
* @param result OK if the configuration has been applied,
@@ -35,7 +35,7 @@
*/
oneway configChange(Result result, BandConfig config);
- /*
+ /**
* Method called by the HAL when a tuning operation completes
* following a step(), scan() or tune() command.
* @param result OK if tune succeeded or TIMEOUT in case of time out.
@@ -43,33 +43,33 @@
*/
oneway tuneComplete(Result result, ProgramInfo info);
- /*
+ /**
* Method called by the HAL when a frequency switch occurs.
* @param info A ProgramInfo structure describing the new tuned station.
*/
oneway afSwitch(ProgramInfo info);
- /*
+ /**
* Method called by the HAL when the antenna connection state changes.
* @param connected True if the antenna is connected, false otherwise.
*/
oneway antennaStateChange(bool connected);
- /*
+ /**
* Method called by the HAL when a traffic announcement starts or
* stops.
* @param active True if the announcement starts, false if it stops.
*/
oneway trafficAnnouncement(bool active);
- /*
+ /**
* Method called by the HAL when an emergency announcement starts
* or stops.
* @param active True if the announcement starts, false if it stops.
*/
oneway emergencyAnnouncement(bool active);
- /*
+ /**
* Method called by the HAL when metadata for current station
* are updated.
* @param channel The channel the metadata is associated with.
@@ -77,4 +77,4 @@
* @param metadata A list of all updated metada.
*/
oneway newMetadata(uint32_t channel, uint32_t subChannel, vec<MetaData> metadata);
-};
\ No newline at end of file
+};
diff --git a/broadcastradio/1.0/types.hal b/broadcastradio/1.0/types.hal
index d8b2da3..045231d 100644
--- a/broadcastradio/1.0/types.hal
+++ b/broadcastradio/1.0/types.hal
@@ -24,33 +24,33 @@
TIMEOUT,
};
-/*
+/**
* Radio hardware module class. A given radio hardware module HAL is of one
* class only. The platform can not have more than one hardware module of
* each class. Current version of the framework only supports RADIO_CLASS_AM_FM.
*/
enum Class : uint32_t {
- /* FM (including HD radio) and AM */
+ /** FM (including HD radio) and AM */
AM_FM = 0,
- /* Satellite Radio */
+ /** Satellite Radio */
SAT = 1,
- /* Digital Radio (DAB) */
+ /** Digital Radio (DAB) */
DT = 2,
};
-/* value for field "type" of radio band described in struct radio_hal_band_config */
+/** value for field "type" of radio band described in struct radio_hal_band_config */
enum Band : uint32_t {
- /* Amplitude Modulation band: LW, MW, SW */
+ /** Amplitude Modulation band: LW, MW, SW */
AM = 0,
- /* Frequency Modulation band: FM */
+ /** Frequency Modulation band: FM */
FM = 1,
- /* FM HD Radio / DRM (IBOC) */
+ /** FM HD Radio / DRM (IBOC) */
FM_HD = 2,
- /* AM HD Radio / DRM (IBOC) */
+ /** AM HD Radio / DRM (IBOC) */
AM_HD = 3,
};
-/* RDS variant implemented. A struct FmBandConfig can list none or several. */
+/** RDS variant implemented. A struct FmBandConfig can list none or several. */
enum Rds : uint32_t {
NONE = 0,
WORLD = (1<<0),
@@ -65,35 +65,35 @@
D75 = (1<<1),
};
-/* Scanning direction for scan() and step() tuner APIs */
+/** Scanning direction for scan() and step() tuner APIs */
enum Direction : uint32_t {
UP,
DOWN
};
-/* Unique handle allocated to a radio module */
+/** Unique handle allocated to a radio module */
typedef uint32_t Handle;
-/* Additional attributes for an FM band configuration */
+/** Additional attributes for an FM band configuration */
struct FmBandConfig {
- /* deemphasis variant */
+ /** deemphasis variant */
Deemphasis deemphasis;
- /* stereo supported */
+ /** stereo supported */
bool stereo;
- /* RDS variants supported */
+ /** RDS variants supported */
Rds rds;
- /* Traffic Announcement supported */
+ /** Traffic Announcement supported */
bool ta;
- /* Alternate Frequency supported */
+ /** Alternate Frequency supported */
bool af;
- /* Emergency announcements supported */
+ /** Emergency announcements supported */
bool ea;
};
-/* Additional attributes for an AM band configuration */
+/** Additional attributes for an AM band configuration */
struct AmBandConfig {
- /* Stereo supported */
+ /** Stereo supported */
bool stereo;
};
@@ -120,83 +120,84 @@
* If more than one tuner is supported (num_tuners > 1), only one can be
* connected to the audio source. */
struct Properties {
- /* Class of this module. E.g AM_FM */
+ /** Class of this module. E.g AM_FM */
Class classId;
- /* implementor name */
+ /** implementor name */
string implementor;
- /* product name */
+ /** product name */
string product;
- /* product version */
+ /** product version */
string version;
- /* serial number (for subscription services) */
+ /** serial number (for subscription services) */
string serial;
- /* number of tuners controllable independently */
+ /** number of tuners controllable independently */
uint32_t numTuners;
- /* number of audio sources driven simultaneously */
+ /** number of audio sources driven simultaneously */
uint32_t numAudioSources;
- /* the hardware supports capture of audio source from audio HAL */
+ /** the hardware supports capture of audio source from audio HAL */
bool supportsCapture;
- vec<BandConfig> bands; /* band descriptors */
+ vec<BandConfig> bands; /** band descriptors */
};
enum MetadataType : int32_t {
INVALID = -1,
- /* Signed 32 bit integer */
+ /** Signed 32 bit integer */
INT = 0,
- /* String */
+ /** String */
TEXT = 1,
- /* Raw binary data (icon or art)
+ /**
+ * Raw binary data (icon or art)
This data must be transparent to the android framework */
RAW = 2,
- /* clock data, see MetaDataClock */
+ /** clock data, see MetaDataClock */
CLOCK = 3,
};
enum MetadataKey : int32_t {
INVALID = -1,
- /* RDS PI - string */
+ /** RDS PI - string */
RDS_PI = 0,
- /* RDS PS - string */
+ /** RDS PS - string */
RDS_PS = 1,
- /* RDS PTY - int32_t */
+ /** RDS PTY - int32_t */
RDS_PTY = 2,
- /* RBDS PTY - int32_t */
+ /** RBDS PTY - int32_t */
RBDS_PTY = 3,
- /* RDS RT - string */
+ /** RDS RT - string */
RDS_RT = 4,
- /* Song title - string */
+ /** Song title - string */
TITLE = 5,
- /* Artist name - string */
+ /** Artist name - string */
ARTIST = 6,
- /* Album name - string */
+ /** Album name - string */
ALBUM = 7,
- /* Musical genre - string */
+ /** Musical genre - string */
GENRE = 8,
- /* Station icon - raw */
+ /** Station icon - raw */
ICON = 9,
- /* Album art - raw */
+ /** Album art - raw */
ART = 10,
- /* Clock - MetaDataClock */
+ /** Clock - MetaDataClock */
CLOCK = 11,
};
struct MetaDataClock {
- /* Seconds since epoch at GMT + 0. */
+ /** Seconds since epoch at GMT + 0. */
uint64_t utcSecondsSinceEpoch;
- /* Minutes offset from the GMT. */
+ /** Minutes offset from the GMT. */
int32_t timezoneOffsetInMinutes;
};
struct MetaData {
MetadataType type;
MetadataKey key;
- /* Value used for type MetadataType.INT */
+ /** Value used for type MetadataType.INT */
int32_t intValue;
- /* Value used for type MetadataType.CLOCK */
+ /** Value used for type MetadataType.CLOCK */
MetaDataClock clockValue;
- /* Value used for type MetadataType.TEXT */
+ /** Value used for type MetadataType.TEXT */
string stringValue;
- /* Value used for type MetadataType.RAW */
+ /** Value used for type MetadataType.RAW */
vec<uint8_t> rawValue;
};
@@ -205,12 +206,12 @@
* Contains information on currently tuned channel.
*/
struct ProgramInfo {
- uint32_t channel; /* current channel. (e.g kHz for band type AM_FM) */
- uint32_t subChannel; /* current sub channel. (FM_HD) */
- bool tuned; /* tuned to a program or not */
- bool stereo; /* program is stereo or not */
- bool digital; /* digital program or not (e.g HD Radio program) */
- uint32_t signalStrength; /* signal strength from 0 to 100 */
- vec<MetaData> metadata; /* non empty if meta data are present (e.g PTY, song title ...) */
+ uint32_t channel; /** current channel. (e.g kHz for band type AM_FM) */
+ uint32_t subChannel; /** current sub channel. (FM_HD) */
+ bool tuned; /** tuned to a program or not */
+ bool stereo; /** program is stereo or not */
+ bool digital; /** digital program or not (e.g HD Radio program) */
+ uint32_t signalStrength; /** signal strength from 0 to 100 */
+ vec<MetaData> metadata; /** non empty if meta data are present (e.g PTY, song title ...) */
};
diff --git a/broadcastradio/1.1/IBroadcastRadio.hal b/broadcastradio/1.1/IBroadcastRadio.hal
index a6347c7..dd37d49 100644
--- a/broadcastradio/1.1/IBroadcastRadio.hal
+++ b/broadcastradio/1.1/IBroadcastRadio.hal
@@ -20,7 +20,7 @@
interface IBroadcastRadio extends @1.0::IBroadcastRadio {
- /*
+ /**
* Retrieve implementation properties.
* @return properties A Properties structure containing implementation
* description and capabilities.
diff --git a/broadcastradio/1.1/ITunerCallback.hal b/broadcastradio/1.1/ITunerCallback.hal
index 1ea57e9..07ce984 100644
--- a/broadcastradio/1.1/ITunerCallback.hal
+++ b/broadcastradio/1.1/ITunerCallback.hal
@@ -25,7 +25,7 @@
* ones, to avoid receiving a callback twice.
*/
interface ITunerCallback extends @1.0::ITunerCallback {
- /*
+ /**
* Method called by the HAL when a tuning operation completes
* following a step(), scan() or tune() command.
* @param result OK if tune succeeded or TIMEOUT in case of time out.
@@ -33,7 +33,7 @@
*/
oneway tuneComplete_1_1(Result result, ProgramInfo info);
- /*
+ /**
* Method called by the HAL when a frequency switch occurs.
* @param info A ProgramInfo structure describing the new tuned station.
*/