From 26154ef9bb1940ce815195e35f82bb704c02f80a Mon Sep 17 00:00:00 2001
From: Balazs Barabas <barabas.balazska@gmail.com>
Date: Thu, 31 Oct 2024 16:13:14 +0200
Subject: [PATCH] added javadoc explanation to handler methods

---
 .../com/meilisearch/sdk/SettingsHandler.java   | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/src/main/java/com/meilisearch/sdk/SettingsHandler.java b/src/main/java/com/meilisearch/sdk/SettingsHandler.java
index 1526371d..c70f9f80 100644
--- a/src/main/java/com/meilisearch/sdk/SettingsHandler.java
+++ b/src/main/java/com/meilisearch/sdk/SettingsHandler.java
@@ -280,7 +280,15 @@ LocalizedAttribute[] getLocalizedAttributes(String uid) throws MeilisearchExcept
                 LocalizedAttribute[].class);
     }
 
-    // javadoc
+    /**
+     * Updates the localized attributes of the index.
+     *
+     * @param uid Index identifier
+     * @param localizedAttributes an array of LocalizedAttributes that contain patterns and locales
+     *     settings
+     * @return TaskInfo instance
+     * @throws MeilisearchException if an error occurs
+     */
     TaskInfo updateLocalizedAttributesSettings(String uid, LocalizedAttribute[] localizedAttributes)
             throws MeilisearchException {
         return httpClient.put(
@@ -291,7 +299,13 @@ TaskInfo updateLocalizedAttributesSettings(String uid, LocalizedAttribute[] loca
                 TaskInfo.class);
     }
 
-    // javadoc
+    /**
+     * Resets the localized attributes of the index
+     *
+     * @param uid Index identifier
+     * @return TaskInfo instance
+     * @throws MeilisearchException if an error occurs
+     */
     TaskInfo resetLocalizedAttributesSettings(String uid) throws MeilisearchException {
         return httpClient.delete(
                 settingsPath(uid).addSubroute("localized-attributes").getURL(), TaskInfo.class);