Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
diff --git a/gnss/1.0/IAGnss.hal b/gnss/1.0/IAGnss.hal
index b8f5746..fb0f606 100644
--- a/gnss/1.0/IAGnss.hal
+++ b/gnss/1.0/IAGnss.hal
@@ -18,7 +18,7 @@
import IAGnssCallback;
-/*
+/**
* Extended interface for AGNSS support.
*/
interface IAGnss {
@@ -30,7 +30,7 @@
IPV4V6 = 3
};
- /*
+ /**
* Opens the AGNSS interface and provides the callback routines to the
* implementation of this interface.
*
@@ -38,21 +38,21 @@
*/
setCallback(IAGnssCallback callback);
- /*
+ /**
* Notifies that the AGNSS data connection has been closed.
*
* @return success True if the operation is successful.
*/
dataConnClosed() generates (bool success);
- /*
+ /**
* Notifies that a data connection is not available for AGNSS.
*
* @return success True if the operation is successful.
*/
dataConnFailed() generates (bool success);
- /*
+ /**
* Sets the hostname and port for the AGNSS server.
*
* @param type Specifies if SUPL or C2K.
@@ -64,7 +64,7 @@
setServer(AGnssType type, string hostname, int32_t port)
generates (bool success);
- /*
+ /**
* Notifies that a data connection is available and sets the name of the
* APN, and its IP type, to be used for SUPL connections.
*
diff --git a/gnss/1.0/IAGnssCallback.hal b/gnss/1.0/IAGnssCallback.hal
index fe2e101..81f1689 100644
--- a/gnss/1.0/IAGnssCallback.hal
+++ b/gnss/1.0/IAGnssCallback.hal
@@ -39,39 +39,39 @@
AGNSS_DATA_CONN_FAILED = 5
};
- /*
+ /**
* Represents the status of AGNSS augmented to support IPv4.
*/
@export(name="", value_prefix="GPS_")
struct AGnssStatusIpV4 {
AGnssType type;
AGnssStatusValue status;
- /*
+ /**
* 32-bit IPv4 address.
*/
uint32_t ipV4Addr;
};
- /*
+ /**
* Represents the status of AGNSS augmented to support IPv6.
*/
struct AGnssStatusIpV6 {
AGnssType type;
AGnssStatusValue status;
- /*
+ /**
* 128-bit IPv6 address.
*/
uint8_t[16] ipV6Addr;
};
- /*
+ /**
* Callback with AGNSS(IpV4) status information.
*
* @param status Will be of type AGnssStatusIpV4.
*/
agnssStatusIpV4Cb(AGnssStatusIpV4 status);
- /*
+ /**
* Callback with AGNSS(IpV6) status information.
*
* @param status Will be of type AGnssStatusIpV6.
diff --git a/gnss/1.0/IAGnssRil.hal b/gnss/1.0/IAGnssRil.hal
index 6292273..6f91f7f 100644
--- a/gnss/1.0/IAGnssRil.hal
+++ b/gnss/1.0/IAGnssRil.hal
@@ -18,7 +18,7 @@
import IAGnssRilCallback;
-/*
+/**
* Extended interface for AGNSS RIL support. An Assisted GNSS Radio Interface
* Layer interface allows the GNSS chipset to request radio interface layer
* information from Android platform. Examples of such information are reference
@@ -50,41 +50,42 @@
LTE_CELLID = 4,
};
- /* CellID for 2G, 3G and LTE, used in AGNSS. */
+ /** CellID for 2G, 3G and LTE, used in AGNSS. */
struct AGnssRefLocationCellID {
AGnssRefLocationType type;
- /* Mobile Country Code. */
+ /** Mobile Country Code. */
uint16_t mcc;
- /* Mobile Network Code .*/
+ /**
+ * Mobile Network Code .*/
uint16_t mnc;
- /*
+ /**
* Location Area Code in 2G, 3G and LTE. In 3G lac is discarded. In LTE,
* lac is populated with tac, to ensure that we don't break old clients that
* might rely in the old (wrong) behavior.
*/
uint16_t lac;
- /* Cell id in 2G. Utran Cell id in 3G. Cell Global Id EUTRA in LTE. */
+ /** Cell id in 2G. Utran Cell id in 3G. Cell Global Id EUTRA in LTE. */
uint32_t cid;
- /* Tracking Area Code in LTE. */
+ /** Tracking Area Code in LTE. */
uint16_t tac;
- /* Physical Cell id in LTE (not used in 2G and 3G) */
+ /** Physical Cell id in LTE (not used in 2G and 3G) */
uint16_t pcid;
};
- /* Represents ref locations */
+ /** Represents ref locations */
struct AGnssRefLocation {
AGnssRefLocationType type;
AGnssRefLocationCellID cellID;
};
- /*
+ /**
* Opens the AGNSS interface and provides the callback routines
* to the implementation of this interface.
*
@@ -92,14 +93,14 @@
*/
setCallback(IAGnssRilCallback callback);
- /*
+ /**
* Sets the reference location.
*
* @param agnssReflocation AGNSS reference location CellID.
*/
setRefLocation(AGnssRefLocation agnssReflocation);
- /*
+ /**
* Sets the SET ID.
*
* @param type Must be populated with either IMSI or MSISDN or NONE.
@@ -114,7 +115,7 @@
*/
setSetId(SetIDType type, string setid) generates (bool success);
- /*
+ /**
* Notify GNSS of network status changes.
*
* @param connected Indicates whether network connectivity exists and
@@ -129,7 +130,7 @@
updateNetworkState(bool connected, NetworkType type, bool roaming)
generates (bool success);
- /*
+ /**
* Notify GNSS of network status changes.
*
* @param available Indicates whether network connectivity is available.
diff --git a/gnss/1.0/IAGnssRilCallback.hal b/gnss/1.0/IAGnssRilCallback.hal
index 2d64e54..d2a1a3f 100644
--- a/gnss/1.0/IAGnssRilCallback.hal
+++ b/gnss/1.0/IAGnssRilCallback.hal
@@ -16,26 +16,26 @@
package android.hardware.gnss@1.0;
-/*
+/**
* Callback for IAGnssRil interface. Used to request SET ID and
* Reference Location.
*/
interface IAGnssRilCallback {
- /* Kinds of SET ID that can be requested */
+ /** Kinds of SET ID that can be requested */
@export(name="", value_prefix="AGPS_RIL_REQUEST_SETID_")
enum ID : uint32_t {
IMSI = 1 << 0L,
MSISDN = 1 << 1L,
};
- /*
+ /**
* The Hal uses this API to request a SET ID.
*
* @param setIdflag Specifies the kind of SET ID that is required by the HAL.
*/
requestSetIdCb(bitfield<ID> setIdflag);
- /*
+ /**
* The Hal uses this API to request a reference location.
*
*/
diff --git a/gnss/1.0/IGnss.hal b/gnss/1.0/IGnss.hal
index 5cde79e..602c615 100644
--- a/gnss/1.0/IGnss.hal
+++ b/gnss/1.0/IGnss.hal
@@ -28,23 +28,23 @@
import IGnssNi;
import IGnssXtra;
-/* Represents the standard GNSS (Global Navigation Satellite System) interface. */
+/** Represents the standard GNSS (Global Navigation Satellite System) interface. */
interface IGnss {
- /* Requested operational mode for GNSS operation. */
+ /** Requested operational mode for GNSS operation. */
@export(name="", value_prefix="GPS_POSITION_MODE_")
enum GnssPositionMode : uint8_t {
/** Mode for running GNSS standalone (no assistance). */
STANDALONE = 0,
/** AGNSS MS-Based mode. */
MS_BASED = 1,
- /*
+ /**
* AGNSS MS-Assisted mode. This mode is not maintained by the platform anymore.
* It is strongly recommended to use MS_BASED instead.
*/
MS_ASSISTED = 2,
};
- /* Requested recurrence mode for GNSS operation. */
+ /** Requested recurrence mode for GNSS operation. */
@export(name="", value_prefix="GPS_POSITION_")
enum GnssPositionRecurrence : uint32_t {
/** Receive GNSS fixes on a recurring basis at a specified period. */
@@ -53,7 +53,7 @@
RECURRENCE_SINGLE = 1
};
- /*
+ /**
* Flags used to specify which aiding data to delete when calling
* deleteAidingData().
*/
@@ -74,7 +74,7 @@
DELETE_ALL = 0xFFFF
};
- /*
+ /**
* Opens the interface and provides the callback routines
* to the implementation of this interface.
*
@@ -84,7 +84,7 @@
*/
setCallback(IGnssCallback callback) generates (bool success);
- /*
+ /**
* Starts a location output stream using the IGnssCallback
* gnssLocationCb(), following the settings from the most recent call to
* setPositionMode().
@@ -96,19 +96,19 @@
*/
start() generates (bool success);
- /*
+ /**
* Stops the location output stream.
*
* @return success Returns true on success.
*/
stop() generates (bool success);
- /*
+ /**
* Closes the interface.
*/
cleanup();
- /*
+ /**
* Injects the current time.
*
* @param timeMs This is the UTC time received from the NTP server, its value
@@ -124,7 +124,7 @@
injectTime(GnssUtcTime timeMs, int64_t timeReferenceMs, int32_t uncertaintyMs)
generates (bool success);
- /*
+ /**
* Injects current location from another location provider (typically cell
* ID).
*
@@ -137,7 +137,7 @@
injectLocation(double latitudeDegrees, double longitudeDegrees, float accuracyMeters)
generates (bool success);
- /*
+ /**
* Specifies that the next call to start will not use the
* information defined in the flags. GnssAidingData value of DELETE_ALL is
* passed for a cold start.
@@ -146,7 +146,7 @@
*/
deleteAidingData(GnssAidingData aidingDataFlags);
- /*
+ /**
* Sets the GnssPositionMode parameter,its associated recurrence value,
* the time between fixes,requested fix accuracy and time to first fix.
*
@@ -165,70 +165,70 @@
uint32_t preferredTimeMs)
generates (bool success);
- /*
+ /**
* This method returns the IAGnssRil Interface.
*
* @return aGnssRilIface Handle to the IAGnssRil interface.
*/
getExtensionAGnssRil() generates (IAGnssRil aGnssRilIface);
- /*
+ /**
* This method returns the IGnssGeofencing Interface.
*
* @return gnssGeofencingIface Handle to the IGnssGeofencing interface.
*/
getExtensionGnssGeofencing() generates(IGnssGeofencing gnssGeofencingIface);
- /*
+ /**
* This method returns the IAGnss Interface.
*
* @return aGnssIface Handle to the IAGnss interface.
*/
getExtensionAGnss() generates (IAGnss aGnssIface);
- /*
+ /**
* This method returns the IGnssNi interface.
*
* @return gnssNiIface Handle to the IGnssNi interface.
*/
getExtensionGnssNi() generates (IGnssNi gnssNiIface);
- /*
+ /**
* This method returns the IGnssMeasurement interface.
*
* @return gnssMeasurementIface Handle to the IGnssMeasurement interface.
*/
getExtensionGnssMeasurement() generates (IGnssMeasurement gnssMeasurementIface);
- /*
+ /**
* This method returns the IGnssNavigationMessage interface.
*
* @return gnssNavigationIface gnssNavigationIface to the IGnssNavigationMessage interface.
*/
getExtensionGnssNavigationMessage() generates (IGnssNavigationMessage gnssNavigationIface);
- /*
+ /**
* This method returns the IGnssXtra interface.
*
* @return xtraIface Handle to the IGnssXtra interface.
*/
getExtensionXtra() generates (IGnssXtra xtraIface);
- /*
+ /**
* This method returns the IGnssConfiguration interface.
*
* @return gnssConfigIface Handle to the IGnssConfiguration interface.
*/
getExtensionGnssConfiguration() generates (IGnssConfiguration gnssConfigIface);
- /*
+ /**
* This method returns the IGnssDebug interface.
*
* @return debugIface Handle to the IGnssDebug interface.
*/
getExtensionGnssDebug() generates (IGnssDebug debugIface);
- /*
+ /**
* This method returns the IGnssBatching interface.
*
* @return batchingIface Handle to the IGnssBatching interface.
diff --git a/gnss/1.0/IGnssBatching.hal b/gnss/1.0/IGnssBatching.hal
index 6f2dde6..a5e01e3 100644
--- a/gnss/1.0/IGnssBatching.hal
+++ b/gnss/1.0/IGnssBatching.hal
@@ -18,7 +18,7 @@
import IGnssBatchingCallback;
-/*
+/**
* Extended interface for GNSS Batching support.
*
* If this interface is supported, this batching request must be able to run in
@@ -39,12 +39,12 @@
*/
interface IGnssBatching {
- /*
+ /**
* Enum which holds the bit masks for batching control.
*/
@export(name="", value_prefix="FLP_BATCH_")
enum Flag : uint8_t {
- /*
+ /**
* If this flag is set, the hardware implementation
* must wake up the application processor when the FIFO is full, and
* call IGnssBatchingCallback to return the locations.
@@ -56,19 +56,19 @@
};
struct Options {
- /*
+ /**
* Time interval between samples in the location batch, in nano
* seconds.
*/
int64_t periodNanos;
- /*
+ /**
* Flags controlling how batching should behave.
*/
bitfield<Flag> flags;
};
- /*
+ /**
* Opens the interface and provides the callback routines
* to the implementation of this interface.
*
@@ -78,7 +78,7 @@
*/
init(IGnssBatchingCallback callback) generates (bool success);
- /*
+ /**
* Return the batch size (in number of GnssLocation objects)
* available in this hardware implementation.
*
@@ -93,7 +93,7 @@
*/
getBatchSize() generates (uint16_t batchSize);
- /*
+ /**
* Start batching locations. This API is primarily used when the AP is
* asleep and the device can batch locations in the hardware.
*
diff --git a/gnss/1.0/IGnssBatchingCallback.hal b/gnss/1.0/IGnssBatchingCallback.hal
index a8f4b88..5697cc4 100644
--- a/gnss/1.0/IGnssBatchingCallback.hal
+++ b/gnss/1.0/IGnssBatchingCallback.hal
@@ -16,9 +16,9 @@
package android.hardware.gnss@1.0;
-/* The callback interface to report measurements from the HAL. */
+/** The callback interface to report measurements from the HAL. */
interface IGnssBatchingCallback {
- /*
+ /**
* Called when a batch of locations is output, by various means, including
* a flush request, as well as the buffer becoming full (if appropriate option
* is set.)
diff --git a/gnss/1.0/IGnssCallback.hal b/gnss/1.0/IGnssCallback.hal
index 0c3b9f0..89e5e0e 100644
--- a/gnss/1.0/IGnssCallback.hal
+++ b/gnss/1.0/IGnssCallback.hal
@@ -16,16 +16,16 @@
package android.hardware.gnss@1.0;
-/*
+/**
* The interface is required for the HAL to communicate certain information
* like status and location info back to the platform, the platform implements
* the interfaces and passes a handle to the HAL.
*/
interface IGnssCallback {
- /* Flags for the gnssSetCapabilities callback. */
+ /** Flags for the gnssSetCapabilities callback. */
@export(name="", value_prefix="GPS_CAPABILITY_")
enum Capabilities : uint32_t {
- /*
+ /**
* GNSS HAL schedules fixes for RECURRENCE_PERIODIC mode.
* If this is not set, then the framework will use 1000ms for
* minInterval and will call start() and stop() to schedule the GNSS.
@@ -47,7 +47,7 @@
NAV_MESSAGES = 1 << 7
};
- /* GNSS status event values. */
+ /** GNSS status event values. */
@export(name="", value_prefix="GPS_STATUS_")
enum GnssStatusValue : uint8_t {
/** GNSS status unknown. */
@@ -62,7 +62,7 @@
ENGINE_OFF = 4
};
- /*
+ /**
* Flags that indicate information about the satellite
*/
@export(name="", value_prefix="GNSS_SV_FLAGS_")
@@ -75,7 +75,7 @@
};
struct GnssSvInfo {
- /*
+ /**
* Pseudo-random number for the SV, or FCN/OSN number for Glonass. The
* distinction is made by looking at constellation field. Values must be
* in the range of:
@@ -93,12 +93,12 @@
*/
int16_t svid;
- /*
+ /**
* Defines the constellation of the given SV.
*/
GnssConstellationType constellation;
- /*
+ /**
* Carrier-to-noise density in dB-Hz, typically in the range [0, 63].
* It contains the measured C/N0 value for the signal at the antenna port.
*
@@ -112,7 +112,7 @@
/** Azimuth of SV in degrees. */
float azimuthDegrees;
- /*
+ /**
* Carrier frequency of the signal tracked, for example it can be the
* GPS central frequency for L1 = 1575.45 MHz, or L2 = 1227.60 MHz, L5 =
* 1176.45 MHz, varying GLO channels, etc. If the field is not set, it
@@ -130,22 +130,22 @@
*/
float carrierFrequencyHz;
- /*
+ /**
* Contains additional data about the given SV.
*/
bitfield<GnssSvFlags> svFlag;
};
- /*
+ /**
* Represents SV status.
*/
struct GnssSvStatus {
- /*
+ /**
* Number of GNSS SVs currently visible, refers to the SVs stored in sv_list
*/
uint32_t numSvs;
- /*
+ /**
* Pointer to an array of SVs information for all GNSS constellations,
* except GNSS, which is reported using svList
*/
@@ -153,26 +153,26 @@
};
- /*
+ /**
* Called when a GNSS location is available.
*
* @param location Location information from HAL.
*/
gnssLocationCb(GnssLocation location);
- /*
+ /**
* Called to communicate the status of the GNSS engine.
*
* @param status Status information from HAL.
*/
gnssStatusCb(GnssStatusValue status);
- /*
+ /**
* @param svInfo SV status information from HAL.
*/
gnssSvStatusCb(GnssSvStatus svInfo);
- /*
+ /**
* Called when NMEA data is available.
* Callback for reporting NMEA sentences.
*
@@ -195,7 +195,7 @@
*/
gnssNmeaCb(GnssUtcTime timestamp, string nmea);
- /*
+ /**
* Callback to inform framework of the GNSS engine's capabilities.
*
* @param capabilities Capability parameter is a bit field of
@@ -203,7 +203,7 @@
*/
gnssSetCapabilitesCb(bitfield<Capabilities> capabilities);
- /*
+ /**
* Callback utility for acquiring the GNSS wakelock. This can be used to prevent
* the CPU from suspending while handling GNSS events.
*/
@@ -215,7 +215,7 @@
/** Callback for requesting NTP time */
gnssRequestTimeCb();
- /*
+ /**
* Provides information about how new the underlying GPS/GNSS hardware and
* software is.
*
@@ -228,14 +228,14 @@
* GnssMeasurement support will be verified.
*/
struct GnssSystemInfo{
- /*
+ /**
* year in which the last update was made to the underlying hardware/firmware
* used to capture GNSS signals, e.g. 2016
*/
uint16_t yearOfHw;
};
- /*
+ /**
* Callback to inform framework of the engine's hardware version information.
*
* @param info GnssSystemInfo about the GPS/GNSS hardware.
diff --git a/gnss/1.0/IGnssConfiguration.hal b/gnss/1.0/IGnssConfiguration.hal
index 2fb6e4e..e315286 100644
--- a/gnss/1.0/IGnssConfiguration.hal
+++ b/gnss/1.0/IGnssConfiguration.hal
@@ -16,68 +16,68 @@
package android.hardware.gnss@1.0;
-/*
+/**
* Interface for passing GNSS configuration info from platform to HAL.
*/
interface IGnssConfiguration {
- /*
+ /**
* Enum which holds the bit masks for SUPL_MODE configuration parameter.
*/
enum SuplMode : uint8_t {
- /* Mobile Station Based */
+ /** Mobile Station Based */
MSB = 0x01,
- /* Mobile Station Assisted */
+ /** Mobile Station Assisted */
MSA = 0x02
};
- /*
+ /**
* Enum which holds the bit masks for GPS_LOCK configuration parameter.
*/
enum GpsLock : uint8_t {
- /* Lock Mobile Originated GPS functionalitues. */
+ /** Lock Mobile Originated GPS functionalitues. */
MO = 0x01,
- /* Lock Network initiated GPS functionalities. */
+ /** Lock Network initiated GPS functionalities. */
NI = 0x02
};
- /*
+ /**
* Enum that hold the bit masks for various LTE Positioning Profile settings (LPP_PROFILE
* configuration parameter). If none of the bits in the enum are set, the default setting is
* Radio Resource Location Protocol(RRLP).
*/
enum LppProfile : uint8_t {
- /* Enable LTE Positioning Protocol user plane */
+ /** Enable LTE Positioning Protocol user plane */
USER_PLANE = 0x01,
- /* Enable LTE Positioning Protocol Control plane */
+ /** Enable LTE Positioning Protocol Control plane */
CONTROL_PLANE = 0x02
};
- /*
+ /**
* Enum which holds the bit masks for A_GLONASS_POS_PROTOCOL_SELECT
* configuration parameter.
*/
enum GlonassPosProtocol : uint8_t {
- /* Radio Resource Control(RRC) control-plane. */
+ /** Radio Resource Control(RRC) control-plane. */
RRC_CPLANE = 0x01,
- /* Radio Resource Location user-plane. */
+ /** Radio Resource Location user-plane. */
RRLP_CPLANE = 0x02,
- /* LTE Positioning Protocol User plane */
+ /** LTE Positioning Protocol User plane */
LPP_UPLANE = 0x04
};
- /*
+ /**
* IMPORTANT: GNSS HAL must expect the below methods to be called multiple
* times. They can be called even when GnssLocationProvider is already
* constructed and enabled. GNSS HAL must maintain the existing requests
* for various callbacks regardless the change in configuration data.
*/
- /*
+ /**
* This method enables or disables emergency SUPL.
*
* @param enabled True if emergency SUPL is to be enabled.
@@ -86,7 +86,7 @@
*/
setSuplEs(bool enabled) generates (bool success);
- /*
+ /**
* This method sets the SUPL version requested by Carrier. The GNSS HAL
* must use this version of the SUPL protocol if supported.
*
@@ -99,7 +99,7 @@
*/
setSuplVersion(uint32_t version) generates (bool success);
- /*
+ /**
* This method sets the SUPL mode.
*
* @param mode Bit mask that specifies the SUPL mode which is set with the SuplMode enum.
@@ -108,7 +108,7 @@
*/
setSuplMode(bitfield<SuplMode> mode) generates (bool success);
- /*
+ /**
* This setting configures how GPS functionalities should be locked when
* user turns off GPS On setting.
*
@@ -119,7 +119,7 @@
*/
setGpsLock(bitfield<GpsLock> lock) generates (bool success);
- /*
+ /**
* This method sets the LTE Positioning Profile configuration.
*
* @param lppProfile Bitmask that specifies the LTE Positioning Profile
@@ -129,7 +129,7 @@
*/
setLppProfile(bitfield<LppProfile> lppProfile) generates (bool success);
- /*
+ /**
* This method selects positioning protocol on A-Glonass system.
*
* @param protocol Bitmask that specifies the positioning protocol to be
@@ -139,7 +139,7 @@
*/
setGlonassPositioningProtocol(bitfield<GlonassPosProtocol> protocol) generates (bool success);
- /*
+ /**
* This method configures which PDN to use.
*
* @param enable Use emergency PDN if true and regular PDN if false.
diff --git a/gnss/1.0/IGnssDebug.hal b/gnss/1.0/IGnssDebug.hal
index 8784d1a..9c1038f 100644
--- a/gnss/1.0/IGnssDebug.hal
+++ b/gnss/1.0/IGnssDebug.hal
@@ -1,107 +1,107 @@
package android.hardware.gnss@1.0;
-/* Extended interface for DEBUG support. */
+/** Extended interface for DEBUG support. */
interface IGnssDebug {
enum SatelliteEphemerisType : uint8_t {
- /* no information is known to the gnss hardware, about this satellite */
+ /** no information is known to the gnss hardware, about this satellite */
UNKNOWN,
- /* this satellite is known to exist */
+ /** this satellite is known to exist */
KNOWN,
- /* this satellite is not known to exist */
+ /** this satellite is not known to exist */
NONEXISTENT,
- /* Only Almanac (approximate) location known for this satellite */
+ /** Only Almanac (approximate) location known for this satellite */
ALMANAC_ONLY,
- /* Ephemeris is known from demodulating the signal on device */
+ /** Ephemeris is known from demodulating the signal on device */
DEMODULATED,
- /* Ephemeris has been provided by SUPL */
+ /** Ephemeris has been provided by SUPL */
SUPL_PROVIDED,
- /* Ephemeris has been provided by another server */
+ /** Ephemeris has been provided by another server */
OTHER_SERVER_PROVIDED,
- /*
+ /**
* Predicted ephemeris has been provided by a server
* (e.g. Xtra, Extended Ephemeris, etc...)
*/
SERVER_PREDICTED,
- /*
+ /**
* Predicted ephemeris in use, generated locally on the device (e.g. from prior
* ephemeris)
*/
LOCALLY_PREDICTED
};
- /*
+ /**
* Provides the current best known position from any
* source (GNSS or injected assistance).
*/
struct PositionDebug {
- /*
+ /**
* Validity of the data in this struct. False only if no
* latitude/longitude information is known.
*/
bool valid;
- /* Latitude expressed in degrees */
+ /** Latitude expressed in degrees */
double latitudeDegrees;
- /* Longitude expressed in degrees */
+ /** Longitude expressed in degrees */
double longitudeDegrees;
- /* Altitude above ellipsoid expressed in meters */
+ /** Altitude above ellipsoid expressed in meters */
float altitudeMeters;
- /* Represents speed in meters per second. */
+ /** Represents speed in meters per second. */
float speedMetersPerSec;
- /* Represents heading in degrees. */
+ /** Represents heading in degrees. */
float bearingDegrees;
- /*
+ /**
* estimated horizontal accuracy of position expressed in meters, radial,
* 68% confidence.
*/
double horizontalAccuracyMeters;
- /*
+ /**
* estimated vertical accuracy of position expressed in meters, with
* 68% confidence.
*/
double verticalAccuracyMeters;
- /*
+ /**
* estimated speed accuracy in meters per second with 68% confidence.
*/
double speedAccuracyMetersPerSecond;
- /*
+ /**
* estimated bearing accuracy degrees with 68% confidence.
*/
double bearingAccuracyDegrees;
- /*
+ /**
* Time duration before this report that this position information was
* valid.
*/
float ageSeconds;
};
- /*
+ /**
* Provides the current best known UTC time estimate.
*/
struct TimeDebug {
- /*
+ /**
* Validity of the data in the struct.
* False if current time is unknown.
*/
bool valid;
- /*
+ /**
* UTC time estimate.
*/
GnssUtcTime timeEstimate;
- /* 68% error estimate in time. */
+ /** 68% error estimate in time. */
float timeUncertaintyNs;
};
- /*
+ /**
* Provides a single satellite info that has decoded navigation data.
*/
struct SatelliteData {
- /* Satellite vehicle ID number */
+ /** Satellite vehicle ID number */
int16_t svid;
- /* Defines the constellation type of the given SV. */
+ /** Defines the constellation type of the given SV. */
GnssConstellationType constellation;
- /* Defines the ephemeris type of the satellite. */
+ /** Defines the ephemeris type of the satellite. */
SatelliteEphemerisType ephemerisType;
- /*
+ /**
* Time duration before this report, that the ephemeris source was last
* updated, e.g. latest demodulation, or latest server download.
* Set to 0 when ephemerisType is UNKNOWN.
@@ -109,16 +109,16 @@
float ephemerisAgeSeconds;
};
- /*
+ /**
* Provides a set of debug information that is filled by the GNSS chipset
* when the method getDebugData() is invoked.
*/
struct DebugData {
- /* Current best known position. */
+ /** Current best known position. */
PositionDebug position;
- /* Current best know time estimate */
+ /** Current best know time estimate */
TimeDebug time;
- /*
+ /**
* Provides a list of the decoded satellite ephemeris.
* Must provide a complete list for all constellations device can track,
* including GnssConstellationType UNKNOWN.
@@ -127,7 +127,7 @@
};
- /*
+ /**
* This methods requests position, time and satellite ephemeris debug information
* from the HAL.
*
diff --git a/gnss/1.0/IGnssGeofenceCallback.hal b/gnss/1.0/IGnssGeofenceCallback.hal
index 722317e..a73790a 100644
--- a/gnss/1.0/IGnssGeofenceCallback.hal
+++ b/gnss/1.0/IGnssGeofenceCallback.hal
@@ -16,7 +16,7 @@
package android.hardware.gnss@1.0;
-/*
+/**
* GNSS Geofence.
* There are 3 states associated with a Geofence: Inside, Outside, Unknown.
* There are 3 transitions: ENTERED, EXITED, UNCERTAIN.
@@ -114,7 +114,7 @@
ERROR_GENERIC = -149
};
- /*
+ /**
* The callback associated with the geofence transition.
* The callback must only be called when the caller is interested in that
* particular transition. For instance, if the caller is interested only in
@@ -134,7 +134,7 @@
gnssGeofenceTransitionCb(int32_t geofenceId, GnssLocation location,
GeofenceTransition transition, GnssUtcTime timestamp);
- /*
+ /**
* The callback associated with the availability of the GNSS system for
* geofencing monitoring. If the GNSS system determines that it cannot monitor
* geofences because of lack of reliability or unavailability of the GNSS
@@ -145,7 +145,7 @@
*/
gnssGeofenceStatusCb(GeofenceAvailability status, GnssLocation lastLocation);
- /*
+ /**
* The callback associated with the addGeofence call.
*
* @param geofenceId Id of the geofence.
@@ -159,7 +159,7 @@
*/
gnssGeofenceAddCb(int32_t geofenceId, GeofenceStatus status);
- /*
+ /**
* The callback associated with the removeGeofence call.
*
* @param geofenceId Id of the geofence.
@@ -169,7 +169,7 @@
*/
gnssGeofenceRemoveCb(int32_t geofenceId, GeofenceStatus status);
- /*
+ /**
* The callback associated with the pauseGeofence call.
*
* @param geofenceId Id of the geofence.
@@ -180,7 +180,7 @@
*/
gnssGeofencePauseCb(int32_t geofenceId, GeofenceStatus status);
- /*
+ /**
* The callback associated with the resumeGeofence call.
*
* @param geofenceId - Id of the geofence.
diff --git a/gnss/1.0/IGnssGeofencing.hal b/gnss/1.0/IGnssGeofencing.hal
index b8348b3..562355a 100644
--- a/gnss/1.0/IGnssGeofencing.hal
+++ b/gnss/1.0/IGnssGeofencing.hal
@@ -18,9 +18,9 @@
import IGnssGeofenceCallback;
-/* Extended interface for GNSS Geofencing support */
+/** Extended interface for GNSS Geofencing support */
interface IGnssGeofencing {
- /*
+ /**
* Opens the geofence interface and provides the callback routines
* to the HAL.
*
@@ -28,7 +28,7 @@
*/
setCallback(IGnssGeofenceCallback callback);
- /*
+ /**
* Add a geofence area. This api currently supports circular geofences.
*
* @param geofenceId The id for the geofence. If a geofence with this id
@@ -59,14 +59,14 @@
uint32_t notificationResponsivenessMs,
uint32_t unknownTimerMs);
- /*
+ /**
* Pause monitoring a particular geofence.
*
* @param geofenceId The id for the geofence.
*/
pauseGeofence(int32_t geofenceId);
- /*
+ /**
* Resume monitoring a particular geofence.
*
* @param geofenceId - The id for the geofence.
@@ -78,7 +78,7 @@
resumeGeofence(int32_t geofenceId,
bitfield<IGnssGeofenceCallback.GeofenceTransition> monitorTransitions);
- /*
+ /**
* Remove a geofence area. After the function returns, no notifications
* must be sent.
*
diff --git a/gnss/1.0/IGnssMeasurement.hal b/gnss/1.0/IGnssMeasurement.hal
index 8329442..fad83d2 100644
--- a/gnss/1.0/IGnssMeasurement.hal
+++ b/gnss/1.0/IGnssMeasurement.hal
@@ -18,7 +18,7 @@
import IGnssMeasurementCallback;
-/*
+/**
* Extended interface for GNSS Measurements support.
*/
interface IGnssMeasurement {
@@ -29,7 +29,7 @@
ERROR_GENERIC = -101
};
- /*
+ /**
* Initializes the interface and registers the callback routines with the HAL.
* After a successful call to 'setCallback' the HAL must begin to provide updates at
* an average output rate of 1Hz (occasional
@@ -46,7 +46,7 @@
*/
setCallback(IGnssMeasurementCallback callback) generates (GnssMeasurementStatus initRet);
- /*
+ /**
* Stops updates from the HAL, and unregisters the callback routines.
* After a call to close(), the previously registered callbacks must be
* considered invalid by the HAL.
diff --git a/gnss/1.0/IGnssMeasurementCallback.hal b/gnss/1.0/IGnssMeasurementCallback.hal
index 5789621..467bf19 100644
--- a/gnss/1.0/IGnssMeasurementCallback.hal
+++ b/gnss/1.0/IGnssMeasurementCallback.hal
@@ -16,9 +16,9 @@
package android.hardware.gnss@1.0;
-/* The callback interface to report measurements from the HAL. */
+/** The callback interface to report measurements from the HAL. */
interface IGnssMeasurementCallback {
- /*
+ /**
* Flags to indicate what fields in GnssClock are valid.
*/
@export(name="", value_prefix="GNSS_CLOCK_")
@@ -39,7 +39,7 @@
HAS_DRIFT_UNCERTAINTY = 1 << 6
};
- /*
+ /**
* Flags to indicate what fields in GnssMeasurement are valid.
*/
@export(name="", value_prefix="GNSS_MEASUREMENT_")
@@ -58,7 +58,7 @@
HAS_AUTOMATIC_GAIN_CONTROL = 1 << 13
};
- /*
+ /**
* Enumeration of available values for the GNSS Measurement's multipath
* indicator.
*/
@@ -72,7 +72,7 @@
INDICATIOR_NOT_PRESENT = 2
};
- /*
+ /**
* Flags indicating the GNSS measurement state.
*
* The expected behavior here is for GNSS HAL to set all the flags that applies.
@@ -106,7 +106,7 @@
STATE_GLO_TOD_KNOWN = 1 << 15,
};
- /*
+ /**
* Flags indicating the Accumulated Delta Range's states.
*/
@export(name="", value_prefix="GNSS_")
@@ -117,17 +117,17 @@
ADR_STATE_CYCLE_SLIP = 1 << 2,
};
- /*
+ /**
* Represents an estimate of the GNSS clock time.
*/
struct GnssClock {
- /*
+ /**
* A set of flags indicating the validity of the fields in this data
* structure.
*/
bitfield<GnssClockFlags> gnssClockFlags;
- /*
+ /**
* Leap second data.
* The sign of the value is defined by the following equation:
* utcTimeNs = timeNs - (fullBiasNs + biasNs) - leapSecond *
@@ -138,7 +138,7 @@
*/
int16_t leapSecond;
- /*
+ /**
* The GNSS receiver internal clock value. This is the local hardware clock
* value.
*
@@ -159,7 +159,7 @@
*/
int64_t timeNs;
- /*
+ /**
* 1-Sigma uncertainty associated with the clock's time in nanoseconds.
* The uncertainty is represented as an absolute (single sided) value.
*
@@ -170,7 +170,7 @@
*/
double timeUncertaintyNs;
- /*
+ /**
* The difference between hardware clock ('time' field) inside GNSS receiver
* and the true GNSS time since 0000Z, January 6, 1980, in nanoseconds.
*
@@ -187,7 +187,7 @@
*/
int64_t fullBiasNs;
- /*
+ /**
* Sub-nanosecond bias.
* The error estimate for the sum of this and the fullBiasNs is the
* biasUncertaintyNs.
@@ -198,7 +198,7 @@
*/
double biasNs;
- /*
+ /**
* 1-Sigma uncertainty associated with the local estimate of GNSS time (clock
* bias) in nanoseconds. The uncertainty is represented as an absolute
* (single sided) value.
@@ -209,7 +209,7 @@
*/
double biasUncertaintyNs;
- /*
+ /**
* The clock's drift in nanoseconds (per second).
*
* A positive value means that the frequency is higher than the nominal
@@ -223,7 +223,7 @@
*/
double driftNsps;
- /*
+ /**
* 1-Sigma uncertainty associated with the clock's drift in nanoseconds (per
* second).
* The uncertainty is represented as an absolute (single sided) value.
@@ -234,7 +234,7 @@
*/
double driftUncertaintyNsps;
- /*
+ /**
* When there are any discontinuities in the HW clock, this field is
* mandatory.
*
@@ -267,7 +267,7 @@
};
- /*
+ /**
* Represents a GNSS Measurement, it contains raw and computed information.
*
* All signal measurement information (e.g. svTime,
@@ -277,24 +277,24 @@
* position, velocity, or time.
*/
struct GnssMeasurement{
- /*
+ /**
* A set of flags indicating the validity of the fields in this data
* structure.
*/
bitfield<GnssMeasurementFlags> flags;
- /*
+ /**
* Satellite vehicle ID number, as defined in GnssSvInfo::svid
* This is a mandatory value.
*/
int16_t svid;
- /*
+ /**
* Defines the constellation of the given SV.
*/
GnssConstellationType constellation;
- /*
+ /**
* Time offset at which the measurement was taken in nanoseconds.
* The reference receiver's time is specified by GnssData::clock::timeNs.
*
@@ -307,7 +307,7 @@
*/
double timeOffsetNs;
- /*
+ /**
* Per satellite sync state. It represents the current sync state for the
* associated satellite.
* Based on the sync state, the 'received GNSS tow' field must be interpreted
@@ -317,7 +317,7 @@
*/
bitfield<GnssMeasurementState> state;
- /*
+ /**
* The received GNSS Time-of-Week at the measurement time, in nanoseconds.
* For GNSS & QZSS, this is the received GNSS Time-of-Week at the
* measurement time, in nanoseconds. The value is relative to the
@@ -402,14 +402,14 @@
*/
int64_t receivedSvTimeInNs;
- /*
+ /**
* 1-Sigma uncertainty of the Received GNSS Time-of-Week in nanoseconds.
*
* This value must be populated if 'state' != STATE_UNKNOWN.
*/
int64_t receivedSvTimeUncertaintyInNs;
- /*
+ /**
* Carrier-to-noise density in dB-Hz, typically in the range [0, 63].
* It contains the measured C/N0 value for the signal at the antenna port.
*
@@ -417,7 +417,7 @@
*/
double cN0DbHz;
- /*
+ /**
* Pseudorange rate at the timestamp in m/s. The correction of a given
* Pseudorange Rate value includes corrections for receiver and satellite
* clock frequency errors. Ensure that this field is independent (see
@@ -445,7 +445,7 @@
*/
double pseudorangeRateMps;
- /*
+ /**
* 1-Sigma uncertainty of the pseudorangeRateMps.
* The uncertainty is represented as an absolute (single sided) value.
*
@@ -453,7 +453,7 @@
*/
double pseudorangeRateUncertaintyMps;
- /*
+ /**
* Accumulated delta range's state. It indicates whether ADR is reset or
* there is a cycle slip(indicating loss of lock).
*
@@ -461,7 +461,7 @@
*/
bitfield<GnssAccumulatedDeltaRangeState> accumulatedDeltaRangeState;
- /*
+ /**
* Accumulated delta range since the last channel reset in meters.
* A positive value indicates that the SV is moving away from the receiver.
*
@@ -476,14 +476,14 @@
*/
double accumulatedDeltaRangeM;
- /*
+ /**
* 1-Sigma uncertainty of the accumulated delta range in meters.
* This value must be populated if 'accumulated delta range state' !=
* ADR_STATE_UNKNOWN.
*/
double accumulatedDeltaRangeUncertaintyM;
- /*
+ /**
* Carrier frequency of the signal tracked, for example it can be the
* GPS central frequency for L1 = 1575.45 MHz, or L2 = 1227.60 MHz, L5 =
* 1176.45 MHz, varying GLO channels, etc. If the field is not set, it
@@ -501,7 +501,7 @@
*/
float carrierFrequencyHz;
- /*
+ /**
* The number of full carrier cycles between the satellite and the
* receiver. The reference frequency is given by the field
* 'carrierFrequencyHz'. Indications of possible cycle slips and
@@ -513,7 +513,7 @@
*/
int64_t carrierCycles;
- /*
+ /**
* The RF phase detected by the receiver, in the range [0.0, 1.0].
* This is usually the fractional part of the complete carrier phase
* measurement.
@@ -526,14 +526,14 @@
*/
double carrierPhase;
- /*
+ /**
* 1-Sigma uncertainty of the carrier-phase.
* If the data is available, gnssClockFlags must contain
* HAS_CARRIER_PHASE_UNCERTAINTY.
*/
double carrierPhaseUncertainty;
- /*
+ /**
* An enumeration that indicates the 'multipath' state of the event.
*
* The multipath Indicator is intended to report the presence of overlapping
@@ -554,7 +554,7 @@
*/
GnssMultipathIndicator multipathIndicator;
- /*
+ /**
* Signal-to-noise ratio at correlator output in dB.
* If the data is available, gnssClockFlags must contain MEASUREMENT_HAS_SNR.
* This is the power ratio of the "correlation peak height above the
@@ -562,7 +562,7 @@
*/
double snrDb;
- /*
+ /**
* Automatic gain control (AGC) level. AGC acts as a variable gain
* amplifier adjusting the power of the incoming signal. The AGC level
* may be used to indicate potential interference. When AGC is at a
@@ -581,7 +581,7 @@
double agcLevelDb;
};
- /*
+ /**
* Represents a reading of GNSS measurements. For devices where GnssSystemInfo's
* yearOfHw is set to 2016+, it is mandatory that these be provided, on
* request, when the GNSS receiver is searching/tracking signals.
@@ -590,17 +590,17 @@
* - Reporting of all tracked constellations are encouraged.
*/
struct GnssData {
- /* Number of GnssMeasurement elements. */
+ /** Number of GnssMeasurement elements. */
uint32_t measurementCount;
- /* The array of measurements. */
+ /** The array of measurements. */
GnssMeasurement[GnssMax:SVS_COUNT] measurements;
/** The GNSS clock time reading. */
GnssClock clock;
};
- /*
+ /**
* Callback for the hal to pass a GnssData structure back to the client.
*
* @param data Contains a reading of GNSS measurements.
diff --git a/gnss/1.0/IGnssNavigationMessage.hal b/gnss/1.0/IGnssNavigationMessage.hal
index ddd9169..db46d11 100644
--- a/gnss/1.0/IGnssNavigationMessage.hal
+++ b/gnss/1.0/IGnssNavigationMessage.hal
@@ -18,7 +18,7 @@
import IGnssNavigationMessageCallback;
-/*
+/**
* Extended interface for GNSS navigation message reporting support.
*/
interface IGnssNavigationMessage {
@@ -29,7 +29,7 @@
ERROR_GENERIC = -101
};
- /*
+ /**
* Initializes the interface and registers the callback routines with the HAL.
* After a successful call to 'setCallback' the HAL must begin to provide updates as
* they become available.
@@ -45,7 +45,7 @@
*/
setCallback(IGnssNavigationMessageCallback callback) generates (GnssNavigationMessageStatus initRet);
- /*
+ /**
* Stops updates from the HAL, and unregisters the callback routines.
* After a call to close(), the previously registered callbacks must be
* considered invalid by the HAL.
diff --git a/gnss/1.0/IGnssNavigationMessageCallback.hal b/gnss/1.0/IGnssNavigationMessageCallback.hal
index 2e6b853..714351b 100644
--- a/gnss/1.0/IGnssNavigationMessageCallback.hal
+++ b/gnss/1.0/IGnssNavigationMessageCallback.hal
@@ -18,7 +18,7 @@
/** Represents a GNSS navigation message (or a fragment of it). */
interface IGnssNavigationMessageCallback {
- /*
+ /**
* Enumeration of available values to indicate the GNSS Navigation message
* types.
*
@@ -48,7 +48,7 @@
GAL_F = 0x0602
};
- /*
+ /**
* Status of Navigation Message
* When a message is received properly without any parity error in its
* navigation words, the status must be set to PARITY_PASSED. But if a message is
@@ -65,26 +65,26 @@
};
struct GnssNavigationMessage {
- /*
+ /**
* Satellite vehicle ID number, as defined in GnssSvInfo::svid
* This is a mandatory value.
*/
int16_t svid;
- /*
+ /**
* The type of message contained in the structure.
* This is a mandatory value.
*/
GnssNavigationMessageType type;
- /*
+ /**
* The status of the received navigation message.
* No need to send any navigation message that contains words with parity
* error and cannot be corrected.
*/
bitfield<NavigationMessageStatus> status;
- /*
+ /**
* Message identifier. It provides an index so the complete Navigation
* Message can be assembled.
*
@@ -106,7 +106,7 @@
*/
int16_t messageId;
- /*
+ /**
* Sub-message identifier. If required by the message 'type', this value
* contains a sub-index within the current message (or frame) that is being
* transmitted.
@@ -123,7 +123,7 @@
*/
int16_t submessageId;
- /*
+ /**
* The data of the reported GNSS message. The bytes (or words) are specified
* using big endian format (MSB first). The data is stored and decoded
* in a server for research purposes.
@@ -158,7 +158,7 @@
vec<uint8_t> data;
};
- /*
+ /**
* The callback to report an available fragment of a GNSS navigation messages
* from the HAL.
*
diff --git a/gnss/1.0/IGnssNi.hal b/gnss/1.0/IGnssNi.hal
index c823bf0..fa98ab0 100644
--- a/gnss/1.0/IGnssNi.hal
+++ b/gnss/1.0/IGnssNi.hal
@@ -17,19 +17,19 @@
package android.hardware.gnss@1.0;
import IGnssNiCallback;
-/*
+/**
* Extended interface for Network-initiated (NI) support. This interface is used
* to respond to NI notifications originating from the HAL.
*/
interface IGnssNi {
- /*
+ /**
* Registers the callbacks for HAL to use.
*
* @param callback handle to IGnssNiCallback interface.
*/
setCallback(IGnssNiCallback callback);
- /*
+ /**
* Sends a response to HAL.
*
* @param notifId An ID generated by HAL to associate NI notifications and
diff --git a/gnss/1.0/IGnssNiCallback.hal b/gnss/1.0/IGnssNiCallback.hal
index c5fb223..163ba25 100644
--- a/gnss/1.0/IGnssNiCallback.hal
+++ b/gnss/1.0/IGnssNiCallback.hal
@@ -16,9 +16,9 @@
package android.hardware.gnss@1.0;
-/* GNSS Network Initiated callback interface. */
+/** GNSS Network Initiated callback interface. */
interface IGnssNiCallback {
- /*
+ /**
* GnssNiType constants
*/
@export(name="", value_prefix="GPS_NI_TYPE_")
@@ -28,7 +28,7 @@
UMTS_CTRL_PLANE = 3
};
- /*
+ /**
* GnssNiNotifyFlags constants
*/
@export(name="", value_prefix="GPS_NI_")
@@ -41,7 +41,7 @@
PRIVACY_OVERRIDE = 0x0004,
};
- /*
+ /**
* GNSS NI responses, used to define the response in
* NI structures
*/
@@ -52,7 +52,7 @@
RESPONSE_NORESP = 3,
};
- /*
+ /**
* NI data encoding scheme
*/
@export(name="", value_prefix="GPS_")
@@ -66,59 +66,59 @@
/** Represents an NI request */
struct GnssNiNotification{
- /*
+ /**
* An ID generated by HAL to associate NI notifications and UI
* responses.
*/
int32_t notificationId;
- /*
+ /**
* A type used to distinguish different categories of NI
* events, such as VOICE, UMTS_SUPL etc.
*/
GnssNiType niType;
- /*
+ /**
* Notification/verification options, combinations of GnssNiNotifyFlags
* constants.
*/
bitfield<GnssNiNotifyFlags> notifyFlags;
- /*
+ /**
* Timeout period to wait for user response.
* Set to 0 for no timeout limit. Specified in seconds.
*/
uint32_t timeoutSec;
- /*
+ /**
* Default response when timeout.
*/
GnssUserResponseType defaultResponse;
- /*
+ /**
* String representing the requester of the network inititated location
* request.
*/
string requestorId;
- /*
+ /**
* Notification message. String representing the service(for eg. SUPL-service)
* who sent the network initiated location request.
*/
string notificationMessage;
- /*
+ /**
* requestorId decoding scheme.
*/
GnssNiEncodingType requestorIdEncoding;
- /*
+ /**
* notificationId decoding scheme
*/
GnssNiEncodingType notificationIdEncoding;
};
- /*
+ /**
* Callback with a network initiated request.
*
* @param notification network initiated request.
diff --git a/gnss/1.0/IGnssXtra.hal b/gnss/1.0/IGnssXtra.hal
index 5222fde..a2c8f39 100644
--- a/gnss/1.0/IGnssXtra.hal
+++ b/gnss/1.0/IGnssXtra.hal
@@ -1,12 +1,12 @@
package android.hardware.gnss@1.0;
import IGnssXtraCallback;
-/*
+/**
* This interface is used by the GNSS HAL to request the framework
* to download XTRA data.
*/
interface IGnssXtra {
- /*
+ /**
* Opens the XTRA interface and provides the callback routines
* to the implementation of this interface.
*
@@ -16,7 +16,7 @@
*/
setCallback(IGnssXtraCallback callback) generates (bool success);
- /*
+ /**
* Inject the downloaded XTRA data into the GNSS receiver.
*
* @param xtraData GNSS XTRA data.
diff --git a/gnss/1.0/IGnssXtraCallback.hal b/gnss/1.0/IGnssXtraCallback.hal
index 42df082..838f1ad 100644
--- a/gnss/1.0/IGnssXtraCallback.hal
+++ b/gnss/1.0/IGnssXtraCallback.hal
@@ -1,10 +1,10 @@
package android.hardware.gnss@1.0;
-/*
+/**
* This interface is used by the GNSS HAL to request download of XTRA data.
*/
interface IGnssXtraCallback {
- /*
+ /**
* Callback to request the client to download XTRA data. The client should
* download XTRA data and inject it by calling injectXtraData().
*/
diff --git a/gnss/1.0/types.hal b/gnss/1.0/types.hal
index d5e0e9b..ea2c756 100644
--- a/gnss/1.0/types.hal
+++ b/gnss/1.0/types.hal
@@ -22,10 +22,10 @@
SVS_COUNT = 64,
};
-/* Milliseconds since January 1, 1970 */
+/** Milliseconds since January 1, 1970 */
typedef int64_t GnssUtcTime;
-/*
+/**
* Constellation type of GnssSvInfo
*/
@@ -61,52 +61,52 @@
HAS_BEARING_ACCURACY = 0x0080
};
-/* Represents a location. */
+/** Represents a location. */
struct GnssLocation {
- /* Contains GnssLocationFlags bits. */
+ /** Contains GnssLocationFlags bits. */
bitfield<GnssLocationFlags> gnssLocationFlags;
- /* Represents latitude in degrees. */
+ /** Represents latitude in degrees. */
double latitudeDegrees;
- /* Represents longitude in degrees. */
+ /** Represents longitude in degrees. */
double longitudeDegrees;
- /*
+ /**
* Represents altitude in meters above the WGS 84 reference ellipsoid.
*/
double altitudeMeters;
- /* Represents speed in meters per second. */
+ /** Represents speed in meters per second. */
float speedMetersPerSec;
- /* Represents heading in degrees. */
+ /** Represents heading in degrees. */
float bearingDegrees;
- /*
+ /**
* Represents expected horizontal position accuracy, radial, in meters
* (68% confidence).
*/
float horizontalAccuracyMeters;
- /*
+ /**
* Represents expected vertical position accuracy in meters
* (68% confidence).
*/
float verticalAccuracyMeters;
- /*
+ /**
* Represents expected speed accuracy in meter per seconds
* (68% confidence).
*/
float speedAccuracyMetersPerSecond;
- /*
+ /**
* Represents expected bearing accuracy in degrees
* (68% confidence).
*/
float bearingAccuracyDegrees;
- /* Timestamp for the location fix. */
+ /** Timestamp for the location fix. */
GnssUtcTime timestamp;
};