diff --git a/android/java/.gitignore b/android/java/.gitignore index 626b99594..173ce20c9 100644 --- a/android/java/.gitignore +++ b/android/java/.gitignore @@ -25,3 +25,6 @@ MapboxGLAndroidSDKTestApp/src/main/res/raw/token.txt # Twitter Fabric / Crashlytics fabric.properties + +# Capture files +captures/ diff --git a/android/java/MapboxGLAndroidSDK/build.gradle b/android/java/MapboxGLAndroidSDK/build.gradle index b58f0976e..1031a058d 100644 --- a/android/java/MapboxGLAndroidSDK/build.gradle +++ b/android/java/MapboxGLAndroidSDK/build.gradle @@ -79,13 +79,16 @@ android.libraryVariants.all { variant -> destinationDir = new File(destinationDir, variant.baseName) source = files(variant.javaCompile.source) classpath = files(variant.javaCompile.classpath.files) + files(android.bootClasspath) - options.windowTitle("Mapbox Android SDK") - options.docTitle("Mapbox Android SDK") - options.header("Mapbox Android SDK") + //exclude '**/R.java' + options.windowTitle("Mapbox Android SDK $VERSION_NAME Reference") + options.docTitle("Mapbox Android SDK $VERSION_NAME") + options.header("Mapbox Android SDK $VERSION_NAME Reference") options.bottom("© 2015 Mapbox. All rights reserved.") options.links("http://docs.oracle.com/javase/7/docs/api/") - // TODO this will fail as package-list file not online, need to use offline - options.links("http://d.android.com/reference/") + options.linksOffline("http://d.android.com/reference/", "$System.env.ANDROID_HOME/docs/reference") + options.overview("src/main/java/overview.html") + options.group("Mapbox Android SDK", "com.mapbox.*") + options.group("Third Party Libraries", "com.almeros.*") // TODO exclude generated R, BuildConfig, com.almeros.* } } diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/almeros/android/multitouch/gesturedetectors/package-info.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/almeros/android/multitouch/gesturedetectors/package-info.java index 7f6245e88..abc0a1189 100644 --- a/android/java/MapboxGLAndroidSDK/src/main/java/com/almeros/android/multitouch/gesturedetectors/package-info.java +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/almeros/android/multitouch/gesturedetectors/package-info.java @@ -1,4 +1,4 @@ /** - * Do not use this package. + * Do not use this package. Used internally by the SDK. */ package com.almeros.android.multitouch.gesturedetectors; diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polygon.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polygon.java index 01899a426..32e23fa37 100644 --- a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polygon.java +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polygon.java @@ -80,7 +80,6 @@ public class Polygon extends MultiPoint { /** * UNIMPLEMENTED: Needs implementation in Native. * https://github.com/mapbox/mapbox-gl-native/issues/1737 - * @return stroke width as float */ public void setStrokeWidth(float width) { strokeWidth = width; diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polyline.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polyline.java index decbba2f7..d29ea4e72 100644 --- a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polyline.java +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/Polyline.java @@ -34,7 +34,6 @@ public class Polyline extends MultiPoint { * Sets the width of the polyline. * * @param width in pixels - * @return */ public void setWidth(float width) { this.width = width; diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolylineOptions.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolylineOptions.java index fde8b03b5..3d1ea6c60 100644 --- a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolylineOptions.java +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/PolylineOptions.java @@ -58,7 +58,7 @@ public class PolylineOptions extends MultiPointOptions { * Sets the width of the polyline. * * @param width in pixels - * @return + * @return a new PolylineOptions */ public PolylineOptions width(float width) { ((Polyline)annotation).width = width; diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/package-info.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/package-info.java new file mode 100644 index 000000000..575d10c56 --- /dev/null +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/annotations/package-info.java @@ -0,0 +1,4 @@ +/** + * This package contains classes to add and manage annotations and markers in your map. + */ +package com.mapbox.mapboxsdk.annotations; diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java index 936f3943e..f13fad335 100644 --- a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/Style.java @@ -2,11 +2,22 @@ package com.mapbox.mapboxsdk.constants; import android.support.annotation.StringDef; +import com.mapbox.mapboxsdk.views.MapView; + import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; - +/** +* Style provides URLs to several professional styles designed by Mapbox. +*

+* These styles are all ready to go in your app. To load one, pass it into {@link MapView#setStyleUrl(String)} +* +* @see MapView#setStyleUrl(String) +*/ public class Style { + /** + * Indicates the parameter accepts one of the values from {@link Style}. + */ @StringDef({MAPBOX_STREETS, EMERALD, LIGHT, DARK, SATELLITE}) @Retention(RetentionPolicy.SOURCE) public @interface StyleUrl { diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/package-info.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/package-info.java new file mode 100644 index 000000000..b99119db0 --- /dev/null +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/package-info.java @@ -0,0 +1,4 @@ +/** + * This package provides access to several map related constants and bundled styles. + */ +package com.mapbox.mapboxsdk.constants; diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/package-info.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/package-info.java new file mode 100644 index 000000000..d593884ee --- /dev/null +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/exceptions/package-info.java @@ -0,0 +1,4 @@ +/** + * This package contains exceptions thrown in this SDK. + */ +package com.mapbox.mapboxsdk.exceptions; diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/package-info.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/package-info.java new file mode 100644 index 000000000..bf7dae12a --- /dev/null +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/geometry/package-info.java @@ -0,0 +1,5 @@ +/** + * This package contains classes that deal with geometry and map coordinates. Many SDK functions + * accept or return these classes. + */ +package com.mapbox.mapboxsdk.geometry; diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/http/package-info.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/http/package-info.java new file mode 100644 index 000000000..a5dbf3046 --- /dev/null +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/http/package-info.java @@ -0,0 +1,4 @@ +/** + * Do not use this package. Used internally by the SDK. + */ +package com.mapbox.mapboxsdk.http; diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/package-info.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/package-info.java new file mode 100644 index 000000000..474a55446 --- /dev/null +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/package-info.java @@ -0,0 +1,5 @@ +/** + * This package contains the {@link com.mapbox.mapboxsdk.MapFragment} class. {@code MapFragment} + * provides a quick and easy way to add a map to your app. + */ +package com.mapbox.mapboxsdk; diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/package-info.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/package-info.java new file mode 100644 index 000000000..9d9c0bf4b --- /dev/null +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/utils/package-info.java @@ -0,0 +1,5 @@ +/** + * This package contains the {@link com.mapbox.mapboxsdk.utils.ApiAccess} class. {@code ApiAccess} + * provides a methods to load a Mapbox access token. + */ +package com.mapbox.mapboxsdk.utils; diff --git a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/views/MapView.java b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/views/MapView.java index 76fd32fc7..80998543c 100644 --- a/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/views/MapView.java +++ b/android/java/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/views/MapView.java @@ -1297,7 +1297,7 @@ public final class MapView extends FrameLayout { *

* {@code url} can take the following forms: *