fix javadoc warnings

Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com>
opensearch-project · Jun 21, 2024 · bd55e42 · bd55e42
1 parent becc022
commit bd55e42
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/server/src/main/java/org/opensearch/search/ResourceType.java b/server/src/main/java/org/opensearch/search/ResourceType.java
@@ -23,7 +23,7 @@ public enum ResourceType {
 
     /**
      * The string match here is case-sensitive
-     * @param s
+     * @param s name matching the resource type name
      * @return a {@link ResourceType}
      */
     public static ResourceType fromName(String s) {

diff --git a/.../src/main/java/org/opensearch/search/backpressure/trackers/TaskResourceUsageTrackers.java b/.../src/main/java/org/opensearch/search/backpressure/trackers/TaskResourceUsageTrackers.java
@@ -35,24 +35,25 @@ public TaskResourceUsageTrackers() {
 
     /**
      * adds the tracker for the TrackerType
-     * @param tracker
-     * @param trackerType
+     * @param tracker is {@link TaskResourceUsageTracker} implementation which will be added
+     * @param trackerType is {@link TaskResourceUsageTrackerType} which depicts the implementation type
      */
     public void addTracker(final TaskResourceUsageTracker tracker, final TaskResourceUsageTrackerType trackerType) {
         all.put(trackerType, tracker);
     }
 
     /**
      * getter for tracker for a {@link TaskResourceUsageTrackerType}
-     * @return
+     * @param type for which the implementation is returned
+     * @return the {@link TaskResourceUsageTrackerType}
      */
     public Optional<TaskResourceUsageTracker> getTracker(TaskResourceUsageTrackerType type) {
         return Optional.ofNullable(all.get(type));
     }
 
     /**
      * Method to access all available {@link TaskResourceUsageTracker}
-     * @return
+     * @return all enabled and available {@link TaskResourceUsageTracker}s
      */
     public List<TaskResourceUsageTracker> all() {
         return new ArrayList<>(all.values());
@@ -71,7 +72,7 @@ public static abstract class TaskResourceUsageTracker {
 
         /**
          * for test purposes only
-         * @param resourceUsageBreachEvaluator
+         * @param resourceUsageBreachEvaluator which suggests whether a task should be cancelled or not
          */
         public void setResourceUsageBreachEvaluator(final ResourceUsageBreachEvaluator resourceUsageBreachEvaluator) {
             this.resourceUsageBreachEvaluator = resourceUsageBreachEvaluator;
@@ -109,7 +110,7 @@ public Optional<TaskCancellation.Reason> checkAndMaybeGetCancellationReason(Task
 
         /**
          * Method to get taskCancellations due to this tracker for the given {@link CancellableTask} tasks
-         * @param tasks
+         * @param tasks cancellation eligible tasks due to node duress and search traffic threshold breach
          * @return
          */
         public List<TaskCancellation> getTaskCancellations(List<CancellableTask> tasks) {
@@ -138,7 +139,7 @@ public interface Stats extends ToXContentObject, Writeable {}
         public interface ResourceUsageBreachEvaluator {
             /**
              * evaluates whether the task is eligible for cancellation based on {@link TaskResourceUsageTracker} implementation
-             * @param task
+             * @param task is input to this method on which the cancellation evaluation is performed
              * @return a {@link TaskCancellation.Reason} why this task should be cancelled otherwise empty
              */
             public Optional<TaskCancellation.Reason> evaluate(final Task task);