From 24acf3f56ffeb7c6e28b1bb3cdf7fb2cb7c07c96 Mon Sep 17 00:00:00 2001
From: savsch <unholyexterminator@gmail.com>
Date: Tue, 24 Dec 2024 03:48:12 +0530
Subject: [PATCH] getNearbyItemCount: Added javadoc

---
 .../java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.kt   | 6 ++++++
 .../main/java/fr/free/nrw/commons/nearby/NearbyPlaces.java  | 3 ++-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.kt b/app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.kt
index e8fbc543c..291c834bd 100644
--- a/app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.kt
+++ b/app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.kt
@@ -332,6 +332,12 @@ class OkHttpJsonApiClient @Inject constructor(
         throw Exception(response.message)
     }
 
+    /**
+     * Returns the count of items in the specified area by querying Wikidata.
+     *
+     * @param queryParams: a `NearbyQueryParam` specifying the geographical area.
+     * @return The count of items in the specified area.
+     */
     @Throws(Exception::class)
     fun getNearbyItemCount(
         queryParams: NearbyQueryParams
diff --git a/app/src/main/java/fr/free/nrw/commons/nearby/NearbyPlaces.java b/app/src/main/java/fr/free/nrw/commons/nearby/NearbyPlaces.java
index be68113d4..caae8ee45 100644
--- a/app/src/main/java/fr/free/nrw/commons/nearby/NearbyPlaces.java
+++ b/app/src/main/java/fr/free/nrw/commons/nearby/NearbyPlaces.java
@@ -148,7 +148,8 @@ public class NearbyPlaces {
         }
 
         // minRadius, targetRadius and maxRadius are radii in decameters
-        // unlike other
+        // unlike other radii here, which are in kilometers, to avoid looping over
+        // floating point values
         int minRadius = 0, maxRadius = Math.round(Math.min(300f, Math.min(longGap, latGap))) * 100;
         int targetRadius = maxRadius / 2;
         while (minRadius < maxRadius) {