From 2e6c0263d8455f08ab8c421597190a972dad8dae Mon Sep 17 00:00:00 2001
From: Tobrun <tobrun@mapbox.com>
Date: Fri, 17 Mar 2017 13:24:07 +0100
Subject: 8322 javadoc 5.0.0 release (#8438)

* [android] - update javadoc 5.0.0 release

* update annotation and sources package javadoc

* update javadoc on MapboxMap and MapView
---
 .../mapbox/mapboxsdk/annotations/Annotation.java   | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)

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

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 831c1db5a3..a588ff6d23 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
@@ -6,10 +6,12 @@ import com.mapbox.mapboxsdk.maps.MapView;
 import com.mapbox.mapboxsdk.maps.MapboxMap;
 
 /**
- * Annotation is an overlay on top of a {@link MapView},
- * from which {@link Polygon}, {@link Polyline} and {@link Marker} are derived.
+ * Annotation is an overlay on top of a Map.
  * <p>
- * it manages attachment to a map and identification, but does not require
+ * Known subclasses are {@link Polygon}, {@link Polyline} and {@link Marker}.
+ * </p>
+ * <p>
+ * This class manages attachment to a map and identification, but does not require
  * content to be placed at a geographical point.
  * </p>
  */
@@ -96,6 +98,12 @@ public abstract class Annotation implements Comparable<Annotation> {
     return mapView;
   }
 
+  /**
+   * Compares this Annotation object with another Annotation.
+   *
+   * @param annotation Another Annotation to compare with this object.
+   * @return returns 0 if id's match, 1 if id is lower, -1 if id is higher of another Annotation
+   */
   @Override
   public int compareTo(@NonNull Annotation annotation) {
     if (id < annotation.getId()) {
@@ -107,12 +115,10 @@ public abstract class Annotation implements Comparable<Annotation> {
   }
 
   /**
-   * Compares this {@link PolylineOptions} object with another {@link PolylineOptions} and
-   * determines if their color, alpha, width, and vertices match.
+   * Checks if this Annotation object is equal to another Annotation.
    *
-   * @param object Another {@link PolylineOptions} to compare with this object.
-   * @return True if color, alpha, width, and vertices match this {@link PolylineOptions} object.
-   * Else, false.
+   * @param object Another Annotation to check equality with this object.
+   * @return returns true both id's match else returns false.
    */
   @Override
   public boolean equals(Object object) {
-- 
cgit v1.2.1