From ed1c416cd33946bffc8925cbf0099eef50a27657 Mon Sep 17 00:00:00 2001
From: Peter-Josef Meisch <pj.meisch@sothawo.com>
Date: Mon, 3 Apr 2023 20:20:13 +0200
Subject: [PATCH] Javadoc

Original Pull Request #2516
Closes #2515
---
 .../data/elasticsearch/core/query/BaseQuery.java |  4 ++--
 .../core/query/BaseQueryBuilder.java             | 16 ++++++++++++++++
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/springframework/data/elasticsearch/core/query/BaseQuery.java b/src/main/java/org/springframework/data/elasticsearch/core/query/BaseQuery.java
index 61289c459..832150a02 100755
--- a/src/main/java/org/springframework/data/elasticsearch/core/query/BaseQuery.java
+++ b/src/main/java/org/springframework/data/elasticsearch/core/query/BaseQuery.java
@@ -226,7 +226,7 @@ public class BaseQuery implements Query {
 	}
 
 	/**
-	 * Set Ids for a multi-get request with on this query.
+	 * Set Ids for a multi-get request run with this query. Not used in any other searches.
 	 *
 	 * @param ids list of id values
 	 */
@@ -255,7 +255,7 @@ public class BaseQuery implements Query {
 	}
 
 	/**
-	 * Set Ids with routing values for a multi-get request set on this query.
+	 * Set Ids with routing values for a multi-get request run with this query. Not used in any other searches.
 	 *
 	 * @param idsWithRouting list of id values, must not be {@literal null}
 	 * @since 4.3
diff --git a/src/main/java/org/springframework/data/elasticsearch/core/query/BaseQueryBuilder.java b/src/main/java/org/springframework/data/elasticsearch/core/query/BaseQueryBuilder.java
index 2385c5c6b..c6b0e8d02 100644
--- a/src/main/java/org/springframework/data/elasticsearch/core/query/BaseQueryBuilder.java
+++ b/src/main/java/org/springframework/data/elasticsearch/core/query/BaseQueryBuilder.java
@@ -250,6 +250,11 @@ public abstract class BaseQueryBuilder<Q extends BaseQuery, SELF extends BaseQue
 		return self();
 	}
 
+		/**
+		 * Set Ids for a multi-get request run with this query. Not used in any other searches.
+		 *
+		 * @param ids list of id values
+		 */
 	public SELF withIds(String... ids) {
 
 		this.ids.clear();
@@ -257,6 +262,11 @@ public abstract class BaseQueryBuilder<Q extends BaseQuery, SELF extends BaseQue
 		return self();
 	}
 
+		/**
+		 * Set Ids for a multi-get request run with this query. Not used in any other searches.
+		 *
+		 * @param ids list of id values
+		 */
 	public SELF withIds(Collection<String> ids) {
 
 		Assert.notNull(ids, "ids must not be null");
@@ -372,6 +382,12 @@ public abstract class BaseQueryBuilder<Q extends BaseQuery, SELF extends BaseQue
 		return self();
 	}
 
+		/**
+		 * Set Ids with routing values for a multi-get request run with this query. Not used in any other searches.
+		 *
+		 * @param idsWithRouting list of id values, must not be {@literal null}
+		 * @since 4.3
+		 */
 	public SELF withIdsWithRouting(List<Query.IdWithRouting> idsWithRouting) {
 
 		Assert.notNull(idsWithRouting, "idsWithRouting must not be null");