commenting #1716

6 files changed, 74 insertions, 10 deletions

diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Circle.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Circle.java
index 6111e959f1..f8908465b9 100644
--- a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Circle.java
+++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Circle.java
@@ -5,6 +5,12 @@ import android.graphics.Color;
 
 import com.mapbox.mapboxgl.geometry.LatLng;
 
+/**
+ * UNIMPLEMENTED: Needs implementation in Native.
+ *
+ * https://github.com/mapbox/mapbox-gl-native/issues/1882
+ * https://github.com/mapbox/mapbox-gl-native/issues/1726
+ */
 public class Circle extends Annotation {
 
     LatLng center;
diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/CircleOptions.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/CircleOptions.java
index 8a488e072b..5e97d5b5e4 100644
--- a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/CircleOptions.java
+++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/CircleOptions.java
@@ -3,6 +3,12 @@ package com.mapbox.mapboxgl.annotations;
 
 import com.mapbox.mapboxgl.geometry.LatLng;
 
+/**
+ * UNIMPLEMENTED: Needs implementation in Native.
+ *
+ * https://github.com/mapbox/mapbox-gl-native/issues/1882
+ * https://github.com/mapbox/mapbox-gl-native/issues/1726
+ */
 public class CircleOptions extends AnnotationOptions {
 
     private Circle circle;
@@ -40,11 +46,6 @@ public class CircleOptions extends AnnotationOptions {
         return circle.strokeWidth;
     }
 
-    // TODO: Implement getZIndex of Google Maps Android API
-//    public float getZIndex () {
-//
-//    }
-
     public CircleOptions radius (double radius) {
         circle.radius = radius;
         return this;
@@ -60,9 +61,4 @@ public class CircleOptions extends AnnotationOptions {
         return this;
     }
 
-    // TODO: Implement zIndex of Google Maps Android API
-//    public CircleOptions zIndex (float zIndex) {
-//
-//    }
-
 }
diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Marker.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Marker.java
index ea4fc41e20..5a3c44bddc 100644
--- a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Marker.java
+++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Marker.java
@@ -114,6 +114,14 @@ public class Marker extends Annotation {
         this.snippet = snippet;
     }
 
+    /**
+     * You can specify the name of a sprite to get a marker other than the default marker.
+     * This name can be found in the sprite json file:
+     *
+     * https://github.com/mapbox/mapbox-gl-styles/blob/mb-pages/sprites/mapbox-streets.json
+     *
+     * @param sprite
+     */
     void setSprite(String sprite) {
         this.sprite = sprite;
     }
diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Polygon.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Polygon.java
index 475a2a93c7..41edb2a5d7 100644
--- a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Polygon.java
+++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/Polygon.java
@@ -34,6 +34,11 @@ public class Polygon extends MultiPoint {
         return strokeColor;
     }
 
+    /**
+     * UNIMPLEMENTED: Needs implementation in Native.
+     * https://github.com/mapbox/mapbox-gl-native/issues/1737
+     * @return stroke width as float
+     */
     public float getStrokeWidth() {
         return strokeWidth;
     }
@@ -61,6 +66,8 @@ public class Polygon extends MultiPoint {
 
     /**
      * Sets the alpha (opacity) of the stroke
+     *
+     * UNIMPLEMENTED: Needs implementation in Native.
      */
     public void setStrokeAlpha(float alpha) {
         strokeAlpha = alpha;
@@ -70,6 +77,11 @@ public class Polygon extends MultiPoint {
         strokeColor = color;
     }
 
+    /**
+     * UNIMPLEMENTED: Needs implementation in Native.
+     * https://github.com/mapbox/mapbox-gl-native/issues/1737
+     * @return stroke width as float
+     */
     public void setStrokeWidth(float width) {
         strokeWidth = width;
     }
diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/PolygonOptions.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/PolygonOptions.java
index a640b585d5..25ee750196 100644
--- a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/PolygonOptions.java
+++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/PolygonOptions.java
@@ -31,6 +31,13 @@ public class PolygonOptions extends MultiPointOptions {
         return this;
     }
 
+    /**
+     * UNIMPLEMENTED: Needs implementation in Native.
+     * https://github.com/mapbox/mapbox-gl-native/issues/1729
+     *
+     * @param points - an iterable (list) of points for cutting a hole
+     * @return PolygonOptions - the options object
+     */
     public PolygonOptions addHole (Iterable<LatLng> points) {
         List<LatLng> hole = new ArrayList<>();
         for (LatLng point : points) {
@@ -40,6 +47,12 @@ public class PolygonOptions extends MultiPointOptions {
         return this;
     }
 
+    /**
+     * Sets the color of the polygon.
+     *
+     * @param color - the color in ARGB format
+     * @return PolygonOptions - the options object
+     */
     public PolygonOptions fillColor(int color) {
         ((Polygon)annotation).fillColor = color;
         return this;
@@ -49,6 +62,12 @@ public class PolygonOptions extends MultiPointOptions {
         return ((Polygon)annotation).fillColor;
     }
 
+    /**
+     * UNIMPLEMENTED: Needs implementation in Native.
+     * https://github.com/mapbox/mapbox-gl-native/issues/1729
+     *
+     * @return a list of lists of points for cutting holes
+     */
     public List<List<LatLng>> getHoles() {
         return ((Polygon)annotation).holes;
     }
@@ -61,15 +80,33 @@ public class PolygonOptions extends MultiPointOptions {
         return ((Polygon)annotation).strokeColor;
     }
 
+    /**
+     * UNIMPLEMENTED: Needs implementation in Native.
+     * https://github.com/mapbox/mapbox-gl-native/issues/1737
+     *
+     * @return stroke width as float
+     */
     public float getStrokeWidth() {
         return ((Polygon)annotation).strokeWidth;
     }
 
+    /**
+     * Sets the color of the stroke of the polygon.
+     *
+     * @param color - the color in ARGB format
+     * @return PolygonOptions - the options object
+     */
     public PolygonOptions strokeColor(int color) {
         ((Polygon)annotation).strokeColor = color;
         return this;
     }
 
+    /**
+     * UNIMPLEMENTED: Needs implementation in Native.
+     * https://github.com/mapbox/mapbox-gl-native/issues/1737
+     *
+     * @return stroke width as float
+     */
     public PolygonOptions strokeWidth(float width) {
         ((Polygon)annotation).strokeWidth = width;
         return this;
diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/PolylineOptions.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/PolylineOptions.java
index 41de7d51a6..d825399f7d 100644
--- a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/PolylineOptions.java
+++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxgl/annotations/PolylineOptions.java
@@ -29,6 +29,11 @@ public class PolylineOptions extends MultiPointOptions {
         return this;
     }
 
+    /**
+     * Sets the color of the polyline.
+     *
+     * @param color - the color in ARGB format
+     */
     public PolylineOptions color(int color) {
         ((Polyline)annotation).color = color;
         return this;