From 00d0e093e5e838beb6b30346db2b191fd4d5c807 Mon Sep 17 00:00:00 2001
From: Tobrun <tobrun@mapbox.com>
Date: Mon, 18 Jan 2016 15:07:04 +0100
Subject: [PATCH] [android] #3338 - add consistent javadoc to annotations
 package

---
 .../java/com/mapbox/mapboxsdk/annotations/Annotation.java  | 2 +-
 .../main/java/com/mapbox/mapboxsdk/annotations/Icon.java   | 4 ++++
 .../java/com/mapbox/mapboxsdk/annotations/IconFactory.java | 4 ++++
 .../java/com/mapbox/mapboxsdk/annotations/InfoWindow.java  | 5 +++--
 .../main/java/com/mapbox/mapboxsdk/annotations/Marker.java | 7 ++++---
 .../com/mapbox/mapboxsdk/annotations/MarkerOptions.java    | 4 +---
 .../java/com/mapbox/mapboxsdk/annotations/MultiPoint.java  | 3 +++
 .../com/mapbox/mapboxsdk/annotations/PolygonOptions.java   | 3 +++
 .../com/mapbox/mapboxsdk/annotations/PolylineOptions.java  | 3 +++
 9 files changed, 26 insertions(+), 9 deletions(-)

diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java
index e967c508753..813e489e949 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Annotation.java
@@ -5,7 +5,7 @@
 import com.mapbox.mapboxsdk.views.MapView;
 
 /**
- * Annotation is the most general kind of overlay on top of a map,
+ * Annotation is a overlay on top of a {@link MapView},
  * from which {@link Polygon}, {@link Polyline} and {@link Marker} are derived.
  * <p>
  * it manages attachment to a map and identification, but does not require
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Icon.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Icon.java
index d7e28dde737..b9691914e28 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Icon.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Icon.java
@@ -2,6 +2,10 @@
 
 import android.graphics.Bitmap;
 
+/**
+ * Icon is the visual representation of a {@link Marker} on a {@link com.mapbox.mapboxsdk.views.MapView}.
+ * @see Marker
+ */
 public final class Icon {
     private Bitmap mBitmap;
     private String mId;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/IconFactory.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/IconFactory.java
index 8d58866acd8..bee4ec47c5c 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/IconFactory.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/IconFactory.java
@@ -22,6 +22,10 @@
 import java.io.IOException;
 import java.io.InputStream;
 
+/**
+ * Factory for creating {@link Icon} objects.
+ * @see Icon
+ */
 public final class IconFactory {
 
     private static final String ICON_ID_PREFIX = "com.mapbox.icons.icon_";
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/InfoWindow.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/InfoWindow.java
index 52f42def959..696301cf546 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/InfoWindow.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/InfoWindow.java
@@ -17,7 +17,7 @@
 
 /**
  * <p>
- * A tooltip view shown when a {@link Marker} is tapped.
+ * InfoWindow is a tooltip shown when a {@link Marker} is tapped.
  * </p>
  * <p>
  * This is a UI element placed over a map at a specific geographic location.
@@ -27,11 +27,12 @@ public class InfoWindow {
 
     private WeakReference<Marker> mBoundMarker;
     private WeakReference<MapView> mMapView;
+    protected WeakReference<View> mView;
+
     private float mMarkerHeightOffset;
     private float mViewWidthOffset;
     private PointF mCoordinates;
     private boolean mIsVisible;
-    protected WeakReference<View> mView;
 
     @LayoutRes
     private int mLayoutRes;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java
index 3d3f2dd8f7f..3463801448f 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Marker.java
@@ -9,9 +9,10 @@
 import com.mapbox.mapboxsdk.views.MapView;
 
 /**
- * A marker is a map overlay that shows an icon image at a specific
- * geographical location and can be associated with a {@link InfoWindow}
- * that is shown when the marker is tapped.
+ * Marker is an annotation that shows an icon image at a geographical location.
+ * </p>
+ * An {@link InfoWindow} can be shown when a Marker is pressed
+ * <p>
  */
 public final class Marker extends Annotation {
 
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerOptions.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerOptions.java
index 70537e242e1..a83a6991b2b 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerOptions.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MarkerOptions.java
@@ -10,9 +10,7 @@
 
 /**
  * <p>
- * A builder object for the options configuration {@link com.mapbox.mapboxsdk.annotations.Marker} and
- * {@link com.mapbox.mapboxsdk.annotations.InfoWindow}
- * instances on maps.
+ * Builder for composing {@link com.mapbox.mapboxsdk.annotations.Marker} objects.
  * </p>
  *
  * <h3>Example</h3>
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MultiPoint.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MultiPoint.java
index 5c1dfb119f9..d2aaea1d178 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MultiPoint.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/MultiPoint.java
@@ -5,6 +5,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Multipoint is an abstract annotation for combining geographical locations.
+ */
 public abstract class MultiPoint extends Annotation {
 
     private List<LatLng> points;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolygonOptions.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolygonOptions.java
index a90f63c9df9..30847807b99 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolygonOptions.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolygonOptions.java
@@ -9,6 +9,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Builder for composing {@link Polygon} objects.
+ */
 public final class PolygonOptions implements Parcelable {
 
     public static final Parcelable.Creator<PolygonOptions> CREATOR
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolylineOptions.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolylineOptions.java
index 21411b96bcd..1e625c10fcf 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolylineOptions.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolylineOptions.java
@@ -8,6 +8,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Builder for composing {@link Polyline} objects.
+ */
 public final class PolylineOptions implements Parcelable {