[android] #5113 - added javadoc for MyLocationViewSettings

1 files changed, 117 insertions, 3 deletions

diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationViewSettings.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationViewSettings.java
index 9ae96ebf7b..80bd1b3bef 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationViewSettings.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationViewSettings.java
@@ -6,6 +6,9 @@ import android.support.annotation.IntRange;
 
 import com.mapbox.mapboxsdk.maps.MapView;
 
+/**
+ * Settings to configure the visual appearance of the MyLocationView.
+ */
 public class MyLocationViewSettings {
 
     private MapView mapView;
@@ -52,43 +55,101 @@ public class MyLocationViewSettings {
 
     private int[] padding = new int[4];
 
+    /**
+     * Creates an instance of MyLocationViewSettings
+     *
+     * @param mapView        the MapView that hosts the MyLocationView
+     * @param myLocationView the MyLocationView to apply the settings to
+     * @see MyLocationView
+     */
     public MyLocationViewSettings(MapView mapView, MyLocationView myLocationView) {
         this.mapView = mapView;
         this.myLocationView = myLocationView;
     }
 
+    /**
+     * Returns if the MyLocationView is enabled
+     *
+     * @return true if MyLocationView is enabled,
+     */
     public boolean isEnabled() {
         return enabled;
     }
 
+    /**
+     * Set the enabled state of MyLocationView
+     *
+     * @param enabled true shows the MyLocationView on the map
+     */
     public void setEnabled(boolean enabled) {
         this.enabled = enabled;
         myLocationView.setEnabled(enabled);
     }
 
+    /**
+     * Set the foreground drawable of the MyLocationView
+     * <p>
+     * The foreground drawable is the image visible on screen
+     * </p>
+     *
+     * @param foregroundDrawable        the drawable to show as foreground without bearing
+     * @param foregroundBearingDrawable the drawable to show as foreground when bearing is enabled
+     */
     public void setForegroundDrawable(Drawable foregroundDrawable, Drawable foregroundBearingDrawable) {
         this.foregroundDrawable = foregroundDrawable;
         this.foregroundBearingDrawable = foregroundBearingDrawable;
         myLocationView.setForegroundDrawables(foregroundDrawable, foregroundBearingDrawable);
     }
 
+    /**
+     * Get the foreground drawable when bearing is disabled.
+     *
+     * @return the drawable used as foreground
+     */
     public Drawable getForegroundDrawable() {
         return foregroundDrawable;
     }
 
+    /**
+     * Get the foreground drawable when bearing is enabled.
+     *
+     * @return the bearing drawable used as foreground
+     */
     public Drawable getForegroundBearingDrawable() {
         return foregroundBearingDrawable;
     }
 
+    /**
+     * Set the foreground tint color.
+     * <p>
+     * The color will tint both the foreground and the bearing foreground drawable.
+     * </p>
+     *
+     * @param foregroundTintColor the color to tint the foreground drawable
+     */
     public void setForegroundTintColor(@ColorInt int foregroundTintColor) {
         this.foregroundTintColor = foregroundTintColor;
         myLocationView.setForegroundDrawableTint(foregroundTintColor);
     }
 
+    /**
+     * Get the foreground tint color.
+     *
+     * @return the foreground tint color
+     */
     public int getForegroundTintColor() {
         return foregroundTintColor;
     }
 
+    /**
+     * Set the background drawable of MyLocationView
+     * <p>
+     * Padding can be added to provide an offset to the background
+     * </p>
+     *
+     * @param backgroundDrawable the drawable to show as background
+     * @param padding            the padding added to the background
+     */
     public void setBackgroundDrawable(Drawable backgroundDrawable, int[] padding) {
         this.backgroundDrawable = backgroundDrawable;
         this.backgroundOffset = padding;
@@ -99,46 +160,99 @@ public class MyLocationViewSettings {
         }
     }
 
+    /**
+     * Get the background drawable of MyLocationView.
+     *
+     * @return the drawable used as background
+     */
     public Drawable getBackgroundDrawable() {
         return backgroundDrawable;
     }
 
+    /**
+     * Set the background tint color.
+     *
+     * @param backgroundTintColor the color to tint the background
+     */
     public void setBackgroundTintColor(@ColorInt int backgroundTintColor) {
         this.backgroundTintColor = backgroundTintColor;
         myLocationView.setShadowDrawableTint(backgroundTintColor);
     }
 
+    /**
+     * Get the background tint color.
+     *
+     * @return the background tint color
+     */
     public int getBackgroundTintColor() {
         return backgroundTintColor;
     }
 
+    /**
+     * Get the background offset.
+     *
+     * @return the background offset
+     */
     public int[] getBackgroundOffset() {
         return backgroundOffset;
     }
 
+    /**
+     * Set the MyLocationView padding.
+     *
+     * @param left   the padding left of MyLocationView
+     * @param top    the padding top of MyLocationView
+     * @param right  the padding right of MyLocationView
+     * @param bottom the padding bottom of MyLocaionView
+     */
     public void setPadding(int left, int top, int right, int bottom) {
         padding = new int[]{left, top, right, bottom};
         myLocationView.setContentPadding(padding);
         mapView.invalidateContentPadding();
     }
 
+    /**
+     * Get the MyLocationView padding.
+     *
+     * @return an array describing the padding in a LTRB manner
+     */
     public int[] getPadding() {
         return padding;
     }
 
+    /**
+     * Get the alpha value of the accuracy circle of MyLocationView
+     *
+     * @return the alpha value
+     */
     public int getAccuracyAlpha() {
         return accuracyAlpha;
     }
 
-    public void setAccuracyAlpha(@IntRange(from = 0, to = 255) int arruracyAlpha) {
-        this.accuracyAlpha = arruracyAlpha;
-        myLocationView.setAccuracyAlpha(arruracyAlpha);
+    /**
+     * Set the alpha value of the accuracy circle of MyLocationView
+     *
+     * @param accuracyAlpha the alpha value to set
+     */
+    public void setAccuracyAlpha(@IntRange(from = 0, to = 255) int accuracyAlpha) {
+        this.accuracyAlpha = accuracyAlpha;
+        myLocationView.setAccuracyAlpha(accuracyAlpha);
     }
 
+    /**
+     * Get the accuracy tint color of MyLocationView.
+     *
+     * @return the tint color used for accuracy
+     */
     public int getAccuracyTintColor() {
         return accuracyTintColor;
     }
 
+    /**
+     * Set the accuracy tint color of MyLocationView.
+     *
+     * @param accuracyTintColor the accuracy tint color
+     */
     public void setAccuracyTintColor(@ColorInt int accuracyTintColor) {
         this.accuracyTintColor = accuracyTintColor;
         myLocationView.setAccuracyTint(accuracyTintColor);