Javadoc updates

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150976 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Mark Harwood 2004-05-09 16:03:57 +00:00
parent ac0f42f29a
commit ea277f9b94
3 changed files with 5 additions and 3 deletions

View File

@ -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

View File

@ -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.
*
*/

View File

@ -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();