From ea277f9b94fda64b399bfd2e3227eb63694b9462 Mon Sep 17 00:00:00 2001 From: Mark Harwood Date: Sun, 9 May 2004 16:03:57 +0000 Subject: [PATCH] Javadoc updates git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150976 13f79535-47bb-0310-9956-ffa450edef68 --- .../java/org/apache/lucene/search/highlight/Formatter.java | 1 + .../apache/lucene/search/highlight/QueryTermExtractor.java | 2 +- .../src/java/org/apache/lucene/search/highlight/Scorer.java | 5 +++-- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/Formatter.java b/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/Formatter.java index dd9da353a87..aeee701877f 100644 --- a/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/Formatter.java +++ b/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/Formatter.java @@ -30,6 +30,7 @@ public interface Formatter * * @param originalTermText (unstemmed) term text to highlight * @param stemmedTerm the stemmed form of the originalTermText + * @param score The score for this term returned by Scorer.getTokenScore - one use for this may be to set font weight in highlighted text * @param startOffset the position of the originalTermText in the text being highlighted * * @return highlighted term text diff --git a/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/QueryTermExtractor.java b/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/QueryTermExtractor.java index 6488740125e..55bf4b476cd 100644 --- a/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/QueryTermExtractor.java +++ b/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/QueryTermExtractor.java @@ -27,7 +27,7 @@ import org.apache.lucene.search.TermQuery; /** * Utility class used to extract the terms used in a query, plus any weights. * This class will not find terms for MultiTermQuery, RangeQuery and PrefixQuery classes - * so the caller must pass a rewritten query (see query.rewrite) to obtain a list of + * so the caller must pass a rewritten query (see Query.rewrite) to obtain a list of * expanded terms. * */ diff --git a/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java b/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java index 548f34e5d44..d54c5ab7fbf 100644 --- a/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java +++ b/sandbox/contributions/highlighter/src/java/org/apache/lucene/search/highlight/Scorer.java @@ -39,8 +39,9 @@ public interface Scorer /** - * Called when the highlighter has no more tokens for the current fragment - the scorer will typically - * call setScore() on the fragment passed in startFragment to record total info + * Called when the highlighter has no more tokens for the current fragment - the scorer returns + * the weighting it has derived for the most recent fragment, typically based on the tokens + * passed to getTokenScore(). * */ public float getFragmentScore();