[android] #3338 - add javadoc annotations package

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java

@@ -6,9 +6,11 @@
 
 /**
  * Annotation is the most general kind of overlay on top of a map,
- * from which {@link InfoWindow} and {@link Marker} are derived: it manages
- * attachment to a map and identification, but does not require
+ * from which {@link Polygon}, {@link Polyline} and {@link Marker} are derived.
+ * <p>
+ * it manages attachment to a map and identification, but does not require
  * content to be placed at a geographical point.
+ * </p>
  */
 public abstract class Annotation implements Comparable<Annotation> {
 

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/InfoWindow.java

@@ -17,8 +17,10 @@
 
 /**
  * <p>
- * A tooltip view. This is a UI element placed over a map at a specific geographic
- * location.
+ * A tooltip view shown when a {@link Marker} is tapped.
+ * </p>
+ * <p>
+ * This is a UI element placed over a map at a specific geographic location.
  * </p>
  */
 public class InfoWindow {

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java

@@ -54,6 +54,8 @@ public void hideInfoWindow() {
 
     /**
      * Do not use this method. Used internally by the SDK.
+     *
+     * @return boolean State of a InfoWindow
      */
     public boolean isInfoWindowShown() {
         return infoWindowShown;
@@ -69,6 +71,8 @@ void setSnippet(String snippet) {
 
     /**
      * Do not use this method. Used internally by the SDK.
+     *
+     * @param icon The icon to be used as Marker image
      */
     public void setIcon(@Nullable Icon icon) {
         this.icon = icon;
@@ -84,6 +88,9 @@ void setTitle(String title) {
 
     /**
      * Do not use this method. Used internally by the SDK.
+     *
+     * @param mapView The MapView to show the InfoWindow on.
+     * @return infoWindow The infoWindow to show
      */
     public InfoWindow showInfoWindow(@NonNull MapView mapView) {
         setMapView(mapView);
@@ -127,6 +134,8 @@ void setVisible(boolean visible) {
 
     /**
      * Do not use this method. Used internally by the SDK.
+     *
+     * @param topOffsetPixels the pixels to have as offset
      */
     public void setTopOffsetPixels(int topOffsetPixels) {
         this.topOffsetPixels = topOffsetPixels;

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerOptions.java

@@ -70,6 +70,8 @@ public MarkerOptions() {
 
     /**
      * Do not use this method. Used internally by the SDK.
+     *
+     * @return Marker The build marker
      */
     public Marker getMarker() {
         return marker;

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolygonOptions.java

@@ -96,6 +96,8 @@ public int getFillColor() {
 
     /**
      * Do not use this method. Used internally by the SDK.
+     *
+     * @return Polygon the Polygon to return
      */
     public Polygon getPolygon() {
         return polygon;

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolylineOptions.java

@@ -83,6 +83,7 @@ public float getAlpha() {
      * Sets the color of the polyline.
      *
      * @param color - the color in ARGB format
+     * @return PolyLineOptions The builder used to build a Polyline
      */
     public PolylineOptions color(int color) {
         polyline.setColor(color);
@@ -95,6 +96,7 @@ public int getColor() {
 
     /**
      * Do not use this method. Used internally by the SDK.
+     * @return PolyLine The polyline build by this class.
      */
     public Polyline getPolyline() {
         return polyline;