summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad Leege <bleege@gmail.com>2016-03-18 12:47:39 -0400
committerBrad Leege <bleege@gmail.com>2016-03-18 14:26:07 -0400
commitfff13d0976015650c2c79348dd8d51d25ce0b2d1 (patch)
treee33b7ea59942c5dd37a5eef87050459ce17537a3
parent0a26d8448a15011ce66332dedc2f3b6a157b2cf7 (diff)
downloadqtlocation-mapboxgl-fff13d0976015650c2c79348dd8d51d25ce0b2d1.tar.gz
[android] #4294 - JavaDocs for Telemetry classes
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/MapboxEvent.java3
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/MapboxEventManager.java6
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/TelemetryLocationReceiver.java3
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/TelemetryService.java4
4 files changed, 15 insertions, 1 deletions
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/MapboxEvent.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/MapboxEvent.java
index cd42fc044b..41dec08ee9 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/MapboxEvent.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/MapboxEvent.java
@@ -2,6 +2,9 @@ package com.mapbox.mapboxsdk.telemetry;
import java.io.Serializable;
+/**
+ * Constants for Telemetry Metadata
+ */
public class MapboxEvent implements Serializable {
public static final int VERSION_NUMBER = 2;
public static final String MAPBOX_EVENTS_BASE_URL = "https://api.mapbox.com";
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/MapboxEventManager.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/MapboxEventManager.java
index 97393df4ad..baf37e5c6a 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/MapboxEventManager.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/MapboxEventManager.java
@@ -46,6 +46,10 @@ import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;
+/**
+ * Singleton control center for managing Telemetry Data.
+ * Primary access is via MapboxEventManager.getMapboxEventManager()
+ */
public class MapboxEventManager {
private static final String TAG = "MapboxEventManager";
@@ -86,7 +90,7 @@ public class MapboxEventManager {
* Private Constructor for configuring the single instance per app.
*/
private MapboxEventManager() {
-
+ super();
}
/**
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/TelemetryLocationReceiver.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/TelemetryLocationReceiver.java
index aaf5af22e0..a35a87eb09 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/TelemetryLocationReceiver.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/TelemetryLocationReceiver.java
@@ -8,6 +8,9 @@ import android.location.LocationManager;
import android.os.Handler;
import android.util.Log;
+/**
+ * Listener for Location updates generated by implementing app.
+ */
public class TelemetryLocationReceiver extends BroadcastReceiver {
private static final String TAG = "TelemLocationReceiver";
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/TelemetryService.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/TelemetryService.java
index 820502db64..41989dd8b9 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/TelemetryService.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/telemetry/TelemetryService.java
@@ -1,4 +1,5 @@
package com.mapbox.mapboxsdk.telemetry;
+
import android.app.Service;
import android.content.Context;
import android.content.Intent;
@@ -9,6 +10,9 @@ import android.os.IBinder;
import android.support.annotation.Nullable;
import android.util.Log;
+/**
+ * Manages Startup and Shutdown of Telemetry resources
+ */
public class TelemetryService extends Service {
private static final String TAG = "TelemetryService";