added javadoc explanation to handler methods

meilisearch · Oct 31, 2024 · 26154ef · 26154ef
1 parent 7207d2f
commit 26154ef
Showing 1 changed file with 16 additions and 2 deletions.
diff --git 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);