From 016157c39eca336721b768f8f182e8c30144ce85 Mon Sep 17 00:00:00 2001 From: Tobrun Date: Sat, 6 Aug 2016 11:59:09 -0400 Subject: [android] - javadoc fixes breaking the release build --- .../mapbox/mapboxsdk/offline/OfflineManager.java | 28 +++++++++++++--------- .../mapbox/mapboxsdk/style/layers/CustomLayer.java | 3 ++- .../mapboxsdk/style/layers/PropertyFactory.java | 2 +- .../mapbox/mapboxsdk/style/sources/TileSet.java | 10 ++++---- 4 files changed, 26 insertions(+), 17 deletions(-) diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineManager.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineManager.java index ba6434e06d..7b41184a5a 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineManager.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineManager.java @@ -76,6 +76,7 @@ public class OfflineManager { public interface CreateOfflineRegionCallback { /** * Receives the newly created offline region + * * @param offlineRegion */ void onCreate(OfflineRegion offlineRegion); @@ -95,7 +96,7 @@ public class OfflineManager { private OfflineManager(Context context) { // Get a pointer to the DefaultFileSource instance String assetRoot = getDatabasePath(context); - String cachePath = assetRoot + File.separator + DATABASE_NAME; + String cachePath = assetRoot + File.separator + DATABASE_NAME; mDefaultFileSourcePtr = createDefaultFileSource(cachePath, assetRoot, DEFAULT_MAX_CACHE_SIZE); if (MapboxAccountManager.getInstance() != null) { @@ -142,11 +143,12 @@ public class OfflineManager { } /** - * Checks if external storage is available to at least read. In order for this to work, make - * sure you include - * (or WRITE_EXTERNAL_STORAGE) for API level < 18 in your app Manifest. - * - * Code from https://developer.android.com/guide/topics/data/data-storage.html#filesExternal + * Checks if external storage is available to at least read. In order for this to work, make + * sure you include <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" /> + * (or WRITE_EXTERNAL_STORAGE) for API level < 18 in your app Manifest. + *

+ * Code from https://developer.android.com/guide/topics/data/data-storage.html#filesExternal + *

*/ public static boolean isExternalStorageReadable() { String state = Environment.getExternalStorageState(); @@ -190,8 +192,8 @@ public class OfflineManager { /** * Access token getter/setter - * @param accessToken * + * @param accessToken * @deprecated As of release 4.1.0, replaced by {@link MapboxAccountManager#start(Context, String)} ()} */ @Deprecated @@ -201,8 +203,8 @@ public class OfflineManager { /** * Get Access Token - * @return Access Token * + * @return Access Token * @deprecated As of release 4.1.0, replaced by {@link MapboxAccountManager#getAccessToken()} */ @Deprecated @@ -220,9 +222,10 @@ public class OfflineManager { /** * Retrieve all regions in the offline database. - * + *

* The query will be executed asynchronously and the results passed to the given * callback on the main thread. + *

*/ public void listOfflineRegions(@NonNull final ListOfflineRegionsCallback callback) { listOfflineRegions(mDefaultFileSourcePtr, new ListOfflineRegionsCallback() { @@ -250,13 +253,15 @@ public class OfflineManager { /** * Create an offline region in the database. - * + *

* When the initial database queries have completed, the provided callback will be * executed on the main thread. - * + *

+ *

* Note that the resulting region will be in an inactive download state; to begin * downloading resources, call `OfflineRegion.setDownloadState(DownloadState.STATE_ACTIVE)`, * optionally registering an `OfflineRegionObserver` beforehand. + *

*/ public void createOfflineRegion( @NonNull OfflineRegionDefinition definition, @@ -303,6 +308,7 @@ public class OfflineManager { String cachePath, String assetRoot, long maximumCacheSize); private native void setAccessToken(long defaultFileSourcePtr, String accessToken); + private native String getAccessToken(long defaultFileSourcePtr); private native void listOfflineRegions( diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CustomLayer.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CustomLayer.java index 1a47cbabe4..82ecc09cd7 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CustomLayer.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/CustomLayer.java @@ -2,8 +2,9 @@ package com.mapbox.mapboxsdk.style.layers; /** * Custom layer. - *

+ *

* Experimental feature. Do not use. + *

*/ public class CustomLayer extends Layer { diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/PropertyFactory.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/PropertyFactory.java index 88587dbb5b..1a1aa48065 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/PropertyFactory.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/PropertyFactory.java @@ -7,7 +7,7 @@ import android.support.annotation.ColorInt; /** * Constructs paint/layout properties for Layers * - * @see Layer style documentation */ public class PropertyFactory { diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/TileSet.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/TileSet.java index 1da8827d72..8e0ec8227f 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/TileSet.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/TileSet.java @@ -157,8 +157,9 @@ public class TileSet { * If the array doesn't contain any entries, interactivity is not supported * for this tileset. See https:github.com/mapbox/utfgrid-spec/tree/master/1.2 * for the interactivity specification. - *

+ *

* Example: "http:localhost:8888/admin/1.0.0/broadband/{z}/{x}/{y}.grid.json" + *

*/ public void setGrids(String... grids) { this.grids = grids; @@ -176,8 +177,9 @@ public class TileSet { * All endpoints MUST return the same content for the same URL. * If the array doesn't contain any entries, then no data is present in * the map. - *

+ *

* "http:localhost:8888/admin/data.geojson" + *

*/ public void setData(String... data) { this.data = data; @@ -188,7 +190,7 @@ public class TileSet { } /** - * 0. >= 0, <= 22. An integer specifying the minimum zoom level. + * 0. >= 0, < 22. An integer specifying the minimum zoom level. */ public void setMinZoom(float minZoom) { this.minZoom = minZoom; @@ -199,7 +201,7 @@ public class TileSet { } /** - * 0. >= 0, <= 22. An integer specifying the maximum zoom level. + * 0. >= 0, <= 22. An integer specifying the maximum zoom level. */ public void setMaxZoom(float maxZoom) { this.maxZoom = maxZoom; -- cgit v1.2.1