From f633e403229c56f48e593509238358a074378c14 Mon Sep 17 00:00:00 2001 From: Taylor Smock Date: Wed, 14 Dec 2022 09:18:09 -0700 Subject: [PATCH] Fix JavaDocs Signed-off-by: Taylor Smock --- .../josm/plugins/mapwithai/backend/GetDataRunnable.java | 8 +++++--- .../plugins/mapwithai/data/mapwithai/MapWithAIInfo.java | 2 +- .../plugins/mapwithai/io/mapwithai/ESRISourceReader.java | 5 +++-- .../josm/plugins/mapwithai/tools/Access.java | 4 ++-- .../josm/plugins/mapwithai/tools/MapPaintUtils.java | 2 ++ 5 files changed, 13 insertions(+), 8 deletions(-) diff --git a/src/main/java/org/openstreetmap/josm/plugins/mapwithai/backend/GetDataRunnable.java b/src/main/java/org/openstreetmap/josm/plugins/mapwithai/backend/GetDataRunnable.java index 4e044bcc..e4c9710a 100644 --- a/src/main/java/org/openstreetmap/josm/plugins/mapwithai/backend/GetDataRunnable.java +++ b/src/main/java/org/openstreetmap/josm/plugins/mapwithai/backend/GetDataRunnable.java @@ -68,7 +68,7 @@ public class GetDataRunnable extends RecursiveTask { /** * This is functionally equivalent to - * {@link org.openstreetmap.josm.data.validation.tests.DuplicateNode#NodeHash} + * {@link org.openstreetmap.josm.data.validation.tests.DuplicateNode.NodeHash} */ private static class ILatLonHash implements Hash { private static final double PRECISION = DEGREE_BUFFER; @@ -76,6 +76,8 @@ private static class ILatLonHash implements Hash { /** * Returns the rounded coordinated according to {@link #PRECISION} * + * @param coor The coordinate to round + * @return The rounded coordinate * @see LatLon#roundToOsmPrecision */ private static ILatLon roundCoord(ILatLon coor) { @@ -484,8 +486,8 @@ public static void removeCommonTags(DataSet dataSet) { } /** - * Create an efficient collection ({@link Storage}) of {@link List} and - * {@link Node} objects + * Create an efficient collection ({@link Storage}) of {@link List} of + * {@link Node}s and {@link Node} objects * * @param dataSet The dataset to get nodes from * @return The storage to use diff --git a/src/main/java/org/openstreetmap/josm/plugins/mapwithai/data/mapwithai/MapWithAIInfo.java b/src/main/java/org/openstreetmap/josm/plugins/mapwithai/data/mapwithai/MapWithAIInfo.java index 541367e2..39f7407f 100644 --- a/src/main/java/org/openstreetmap/josm/plugins/mapwithai/data/mapwithai/MapWithAIInfo.java +++ b/src/main/java/org/openstreetmap/josm/plugins/mapwithai/data/mapwithai/MapWithAIInfo.java @@ -659,7 +659,7 @@ public void setAlreadyConflatedKey(String key) { * Get the key that indicates an object is already conflated, and if so, to what * Please note that it may be `true`/`false` instead of an object id. * - * return The key returned by the server indicating the conflation object + * @return The key returned by the server indicating the conflation object */ public String getAlreadyConflatedKey() { return alreadyConflatedKey; diff --git a/src/main/java/org/openstreetmap/josm/plugins/mapwithai/io/mapwithai/ESRISourceReader.java b/src/main/java/org/openstreetmap/josm/plugins/mapwithai/io/mapwithai/ESRISourceReader.java index 4a3e5dae..f90cc986 100644 --- a/src/main/java/org/openstreetmap/josm/plugins/mapwithai/io/mapwithai/ESRISourceReader.java +++ b/src/main/java/org/openstreetmap/josm/plugins/mapwithai/io/mapwithai/ESRISourceReader.java @@ -201,8 +201,9 @@ private ForkJoinTask parse(JsonObject feature) { /** * Get the json string for a URL * - * @param url The URL to get - * @param fastFail Fail fast (1 second) + * @param url The URL to get + * @param fastFail Fail fast (1 second) + * @param defaultMaxAge the default max age for the response to be cached * @return The json string, or {@code null}. */ @Nullable diff --git a/src/main/java/org/openstreetmap/josm/plugins/mapwithai/tools/Access.java b/src/main/java/org/openstreetmap/josm/plugins/mapwithai/tools/Access.java index fee77477..da98cff8 100644 --- a/src/main/java/org/openstreetmap/josm/plugins/mapwithai/tools/Access.java +++ b/src/main/java/org/openstreetmap/josm/plugins/mapwithai/tools/Access.java @@ -405,10 +405,10 @@ public static Collection getByTransportType(AccessTags type) { } /** - * The key for children modes for the map, see {@link Access#getAccessMethods} + * The key for children modes for the map, see {@link Access#accessMethods} */ public static final String CHILDREN = "children"; - /** The key for parent modes for the map, see {@link Access#getAccessMethods} */ + /** The key for parent modes for the map, see {@link Access#accessMethods} */ public static final String PARENT = "parent"; /** This set has keys that indicate that access is possible */ private static final Set POSITIVE_ACCESS = new HashSet<>( diff --git a/src/main/java/org/openstreetmap/josm/plugins/mapwithai/tools/MapPaintUtils.java b/src/main/java/org/openstreetmap/josm/plugins/mapwithai/tools/MapPaintUtils.java index d5ed4caf..0c67374c 100644 --- a/src/main/java/org/openstreetmap/josm/plugins/mapwithai/tools/MapPaintUtils.java +++ b/src/main/java/org/openstreetmap/josm/plugins/mapwithai/tools/MapPaintUtils.java @@ -75,6 +75,8 @@ public enum SafeColors { /** * Get the safe color + * + * @return The safe color */ public Color getColor() { return new Color(this.color.getRGB());