Apache Lucene open-source search software
PayloadScoreQuery javadoc update w.r.t. SpanQuery use (#13731)
Christine Poerschkeef577ea43a99
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/payloads/PayloadScoreQuery.java b/lucene/queries/src/java/org/apache/lucene/queries/payloads/PayloadScoreQuery.javaindex 7c454102779..72d6622b4e3 100644--- a/lucene/queries/src/java/org/apache/lucene/queries/payloads/PayloadScoreQuery.java+++ b/lucene/queries/src/java/org/apache/lucene/queries/payloads/PayloadScoreQuery.java@@ -39,7 +39,11 @@ import org.apache.lucene.search.ScoreMode;import org.apache.lucene.search.ScorerSupplier;import org.apache.lucene.util.BytesRef;-/** A Query class that uses a {@link PayloadFunction} to modify the score of a wrapped SpanQuery */+/**+ * A Query class that uses a {@link PayloadFunction} to modify the score of a wrapped {@link+ * SpanQuery}. A wrapped span query is used due to the way that payload values are indexed, see+ * {@link PostingsEnum#PAYLOADS}.+ */public class PayloadScoreQuery extends SpanQuery {private final SpanQuery wrappedQuery;