From f60faa127e0aa5a945283bdd588d9239017ef8e2 Mon Sep 17 00:00:00 2001
From: Tobrun <tobrun@mapbox.com>
Date: Mon, 18 Jan 2016 15:47:01 +0100
Subject: [PATCH] [android] #3338 - add class javadoc geometry package

---
 .../com/mapbox/mapboxsdk/geometry/CoordinateBounds.java     | 2 +-
 .../com/mapbox/mapboxsdk/geometry/CoordinateRegion.java     | 2 +-
 .../java/com/mapbox/mapboxsdk/geometry/CoordinateSpan.java  | 2 +-
 .../main/java/com/mapbox/mapboxsdk/geometry/ILatLng.java    | 2 +-
 .../com/mapbox/mapboxsdk/geometry/IProjectedMeters.java     | 3 +++
 .../src/main/java/com/mapbox/mapboxsdk/geometry/LatLng.java | 5 +++--
 .../main/java/com/mapbox/mapboxsdk/geometry/LatLngZoom.java | 3 +++
 .../java/com/mapbox/mapboxsdk/geometry/ProjectedMeters.java | 6 ++++--
 8 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateBounds.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateBounds.java
index 1ad584f8c89..4d3e94f7860 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateBounds.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateBounds.java
@@ -1,7 +1,7 @@
 package com.mapbox.mapboxsdk.geometry;
 
 /**
- * Implementation of iOS MGLCoordinateBounds
+ * A rectangular geograpical region defined by a south west {@link LatLng} and a north east {@link LatLng}.
  */
 public class CoordinateBounds {
 
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateRegion.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateRegion.java
index a70bb05a41a..65b30746f05 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateRegion.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateRegion.java
@@ -1,7 +1,7 @@
 package com.mapbox.mapboxsdk.geometry;
 
 /**
- * Implementation of iOS MKCoordinateRegion
+ * A geographical region defined by a {@link LatLng} and a {@link CoordinateSpan}.
  */
 public class CoordinateRegion {
     private LatLng center;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateSpan.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateSpan.java
index 79361f725a3..097e88a765c 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateSpan.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/CoordinateSpan.java
@@ -1,7 +1,7 @@
 package com.mapbox.mapboxsdk.geometry;
 
 /**
- * Implementation of iOS MKCoordinateSpan
+ * A geographical span defined by its latitude and longitude span.
  */
 public class CoordinateSpan {
 
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ILatLng.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ILatLng.java
index 892d0ad4aee..afd22e5ddb8 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ILatLng.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ILatLng.java
@@ -1,7 +1,7 @@
 package com.mapbox.mapboxsdk.geometry;
 
 /**
- * A Latitude, Longitude point.
+ * Describes a latitude, longitude point.
  */
 public interface ILatLng {
     double getLatitude();
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/IProjectedMeters.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/IProjectedMeters.java
index 5aa5f607ebf..43fe25f8e5e 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/IProjectedMeters.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/IProjectedMeters.java
@@ -1,5 +1,8 @@
 package com.mapbox.mapboxsdk.geometry;
 
+/**
+ * Describes a projection in Mercator meters.
+ */
 public interface IProjectedMeters {
     double getNorthing();
 
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/LatLng.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/LatLng.java
index c340b09e05e..419bab949bb 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/LatLng.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/LatLng.java
@@ -10,9 +10,10 @@
 import java.io.Serializable;
 
 /**
+ * A geographical location which contains a single latitude, longitude pair, with
+ * optional altitude.
  * <p>
- * This class is container for a single latitude, longitude pair, with
- * optional altitude. Latitude and longitude are expressed as decimal degrees
+ * Latitude and longitude are expressed as decimal degrees
  * in the WGS84 datum. By default, altitude is 0.0, or sea level.
  * </p>
  * <p>
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/LatLngZoom.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/LatLngZoom.java
index 9e453a391ce..349c0989882 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/LatLngZoom.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/LatLngZoom.java
@@ -5,6 +5,9 @@
 
 import java.io.Serializable;
 
+/**
+ * A geographical location which contains a {@link LatLng}, zoom pair.
+ */
 public class LatLngZoom extends LatLng implements Parcelable, Serializable {
 
     public static final Parcelable.Creator<LatLngZoom> CREATOR = new Parcelable.Creator<LatLngZoom>() {
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ProjectedMeters.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ProjectedMeters.java
index fc821e887c0..61a03ff1547 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ProjectedMeters.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/ProjectedMeters.java
@@ -6,10 +6,12 @@
 import java.io.Serializable;
 
 /**
- * ProjectedMeters is an internal representation of longitude, latitude points that
- * have been projected into Mapbox GL's Mercator projection. Instead of decimal
+ * ProjectedMeters is a projection of longitude, latitude points in Mercator meters.
+ * <p>
+ * these have been projected into Mapbox GL's Mercator projection. Instead of decimal
  * degrees, it uses Mercator meters (which are notably not equivalent to SI meters)
  * except at the equator.
+ * </p>
  */
 public class ProjectedMeters implements IProjectedMeters, Parcelable, Serializable {