updated javadoc comments

This commit is contained in:
Agent-8 2017-12-27 09:49:37 -05:00 committed by GitHub
parent c606f5193f
commit e72819f647
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -4,7 +4,7 @@ import android.location.Location;
import android.support.annotation.NonNull; import android.support.annotation.NonNull;
/** /**
* the latitude and longitude of the user * a latitude and longitude point with accuracy information, often of a picture
*/ */
public class LatLng { public class LatLng {
@ -12,11 +12,18 @@ public class LatLng {
private final double longitude; private final double longitude;
private final float accuracy; private final float accuracy;
/** Accepts latitude and longitude. /**
* North and South values are cut off at 90° * Accepts latitude and longitude.
* North and South values are cut off at 90°
* *
* @param latitude double value * @param latitude the latitude
* @param longitude double value * @param longitude the longitude
* @param accuracy the accuracy
*
* Examples:
* the Statue of Liberty is located at 40.69° N, 74.04° W
* The Statue of Liberty could be constructed as LatLng(40.69, -74.04, 1.0)
* where positive signifies north, east and negative signifies south, west.
*/ */
public LatLng(double latitude, double longitude, float accuracy) { public LatLng(double latitude, double longitude, float accuracy) {
if (-180.0D <= longitude && longitude < 180.0D) { if (-180.0D <= longitude && longitude < 180.0D) {