summaryrefslogtreecommitdiffstats
path: root/location/java
diff options
context:
space:
mode:
authorMike Lockwood <lockwood@android.com>2009-08-06 15:52:55 -0400
committerMike Lockwood <lockwood@android.com>2009-08-06 19:19:45 -0400
commit640992dec96fa88f0bbd42c6a02902640a000b35 (patch)
treec2e3d4130f2230557b5f5fc7b8776b8bb041a1df /location/java
parent509ca0792b7cb14ddcea7d2c7e83159d0621e725 (diff)
downloadframeworks_base-640992dec96fa88f0bbd42c6a02902640a000b35.zip
frameworks_base-640992dec96fa88f0bbd42c6a02902640a000b35.tar.gz
frameworks_base-640992dec96fa88f0bbd42c6a02902640a000b35.tar.bz2
gps: Unhide GpsStatus.NmeaListener interface for receiving NMEA sentences
Signed-off-by: Mike Lockwood <lockwood@android.com>
Diffstat (limited to 'location/java')
-rw-r--r--location/java/android/location/GpsStatus.java9
-rw-r--r--location/java/android/location/LocationManager.java8
2 files changed, 8 insertions, 9 deletions
diff --git a/location/java/android/location/GpsStatus.java b/location/java/android/location/GpsStatus.java
index 883ee4f..ce69ac1 100644
--- a/location/java/android/location/GpsStatus.java
+++ b/location/java/android/location/GpsStatus.java
@@ -116,9 +116,12 @@ public final class GpsStatus {
}
/**
- * Used for receiving NMEA data from the GPS.
- *
- * {@hide}
+ * Used for receiving NMEA sentences from the GPS.
+ * NMEA 0183 is a standard for communicating with marine electronic devices
+ * and is a common method for receiving data from a GPS, typically over a serial port.
+ * See <a href="http://en.wikipedia.org/wiki/NMEA_0183">NMEA 0183</a> for more details.
+ * You can implement this interface and call {@link LocationManager#addNmeaListener}
+ * to receive NMEA data from the GPS engine.
*/
public interface NmeaListener {
void onNmeaReceived(long timestamp, String nmea);
diff --git a/location/java/android/location/LocationManager.java b/location/java/android/location/LocationManager.java
index 8f17e78..8f0352d 100644
--- a/location/java/android/location/LocationManager.java
+++ b/location/java/android/location/LocationManager.java
@@ -1276,13 +1276,11 @@ public class LocationManager {
/**
* Adds an NMEA listener.
*
- * @param listener NMEA listener object to register
+ * @param listener a {#link GpsStatus.NmeaListener} object to register
*
* @return true if the listener was successfully added
*
* @throws SecurityException if the ACCESS_FINE_LOCATION permission is not present
- *
- * {@hide}
*/
public boolean addNmeaListener(GpsStatus.NmeaListener listener) {
boolean result;
@@ -1308,9 +1306,7 @@ public class LocationManager {
/**
* Removes an NMEA listener.
*
- * @param listener NMEA listener object to remove
- *
- * {@hide}
+ * @param listener a {#link GpsStatus.NmeaListener} object to remove
*/
public void removeNmeaListener(GpsStatus.NmeaListener listener) {
try {