From 83df8a8621287e548ee771599c9c98b61b9971a3 Mon Sep 17 00:00:00 2001
From: Tobrun <tobrun@mapbox.com>
Date: Wed, 31 May 2017 09:46:12 +0200
Subject: [android] - javadoc update for 5.1.0 release (#9138)

* [android] - javadoc update for 5.1.0 release

* oxford comma

* Grammar/spelling tweaks

* grammar tweak

* grammar tweak

* Grammar tweaks

* Grammar tweaks
---
 .../main/java/com/mapbox/mapboxsdk/constants/MyBearingTracking.java   | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

(limited to 'platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MyBearingTracking.java')

diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MyBearingTracking.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MyBearingTracking.java
index f53c65d055..88c3bef673 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MyBearingTracking.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MyBearingTracking.java
@@ -16,7 +16,7 @@ import java.lang.annotation.RetentionPolicy;
 public class MyBearingTracking {
 
   /**
-   * Indicates the parameter accepts one of the values from {@link MyBearingTracking}.
+   * Indicates that the parameter accepts one of the values from MyBearingTracking.
    */
   @IntDef( {NONE, COMPASS, GPS, /**COMBINED**/})
   @Retention(RetentionPolicy.SOURCE)
@@ -38,6 +38,4 @@ public class MyBearingTracking {
    */
   public static final int GPS = 0x00000008;
 
-  // public static final int COMBINED = 0x00000012;
-
 }
-- 
cgit v1.2.1


From a9f52e24e63af6d322b3f4744a38aab395344b1d Mon Sep 17 00:00:00 2001
From: Tobrun <tobrun@mapbox.com>
Date: Tue, 20 Jun 2017 15:48:24 +0200
Subject: Revisit Javadoc for 5.1.0 (#9266)

* [android] - revisit public API javadoc

* [android] fix javadoc minor mistakes and typos

* grammar tweak

* add missing public javadoc
---
 .../com/mapbox/mapboxsdk/constants/MyBearingTracking.java  | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

(limited to 'platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MyBearingTracking.java')

diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MyBearingTracking.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MyBearingTracking.java
index 88c3bef673..ceac862f39 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MyBearingTracking.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MyBearingTracking.java
@@ -2,23 +2,27 @@ package com.mapbox.mapboxsdk.constants;
 
 import android.support.annotation.IntDef;
 
+import com.mapbox.mapboxsdk.maps.MapboxMap;
 import com.mapbox.mapboxsdk.maps.widgets.MyLocationView;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 
 /**
- * MyBearingTracking exposes different types bearing tracking modes.
+ * MyBearingTracking exposes different types of bearing tracking modes.
+ * <p>
+ * These modes visualise the user direction by extracting the direction from either sensor or location data.
+ * </p>
+ * <p>
+ * Required to enable showing the user location first through {@link MapboxMap#setMyLocationEnabled(boolean)}.
+ * </p>
  *
  * @see com.mapbox.mapboxsdk.maps.TrackingSettings#setMyBearingTrackingMode(int)
  * @see MyLocationView#setMyBearingTrackingMode(int)
  */
 public class MyBearingTracking {
 
-  /**
-   * Indicates that the parameter accepts one of the values from MyBearingTracking.
-   */
-  @IntDef( {NONE, COMPASS, GPS, /**COMBINED**/})
+  @IntDef( {NONE, COMPASS, GPS})
   @Retention(RetentionPolicy.SOURCE)
   public @interface Mode {
   }
-- 
cgit v1.2.1