diff options
author | Henning Baldersheim <balder@yahoo-inc.com> | 2018-02-02 13:28:47 +0100 |
---|---|---|
committer | Henning Baldersheim <balder@yahoo-inc.com> | 2018-02-02 13:28:47 +0100 |
commit | 701c99093c8f51ecd6509c42072282d246fb4a0d (patch) | |
tree | 3dbc0940e0a76465e789a8d4dd51e3d0e033e154 /container-search | |
parent | c1001f2ffa2a03b933c9eb632eb81872afe34667 (diff) |
Add comment on return value
Diffstat (limited to 'container-search')
-rw-r--r-- | container-search/src/main/java/com/yahoo/prelude/fastsearch/VespaBackEndSearcher.java | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/container-search/src/main/java/com/yahoo/prelude/fastsearch/VespaBackEndSearcher.java b/container-search/src/main/java/com/yahoo/prelude/fastsearch/VespaBackEndSearcher.java index 4c0f3003981..ea354e1291f 100644 --- a/container-search/src/main/java/com/yahoo/prelude/fastsearch/VespaBackEndSearcher.java +++ b/container-search/src/main/java/com/yahoo/prelude/fastsearch/VespaBackEndSearcher.java @@ -493,8 +493,8 @@ public abstract class VespaBackEndSearcher extends PingableSearcher { } static protected class FillHitsResult { - public final int skippedHits; - public final String error; + public final int skippedHits; // Number of hits not producing a summary. + public final String error; // Optional error message FillHitsResult(int skippedHits, String error) { this.skippedHits = skippedHits; this.error = error; @@ -503,7 +503,7 @@ public abstract class VespaBackEndSearcher extends PingableSearcher { /** * Fills the hits. * - * @return the number of hits that we did not return data for, i.e + * @return the number of hits that we did not return data for, and an optional error message. * when things are working normally we return 0. */ protected FillHitsResult fillHits(Result result, int packetIndex, Packet[] packets, String summaryClass) throws IOException { |