Javadoc

Original Pull Request spring-projects#2516
Closes spring-projects#2515

Author: sothawo

src/main/java/org/springframework/data/elasticsearch/core/query/BaseQuery.java

@@ -226,7 +226,7 @@ public void setMinScore(float minScore) {
 	}
 
 	/**
-	 * 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 List<IdWithRouting> getIdsWithRouting() {
 	}
 
 	/**
-	 * 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

src/main/java/org/springframework/data/elasticsearch/core/query/BaseQueryBuilder.java

@@ -250,13 +250,23 @@ public SELF withMaxResults(Integer maxResults) {
 		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();
 		this.ids.addAll(Arrays.asList(ids));
 		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 SELF withRequestCache(@Nullable Boolean requestCache) {
 		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");