Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-4787: Fixed some highlighting javadocs.

This commit is contained in:
Adrien Grand 2016-06-09 16:17:25 +02:00
parent 7a4565e298
commit bd7689b74d
3 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lucene/CHANGES.txt
View File

@ -7,7 +7,12 @@ http://s.apache.org/luceneversions
Bug Fixes
LUCENE-6662: Fixed potential resource leaks. (Rishabh Patel via Adrien Grand)
* LUCENE-6662: Fixed potential resource leaks. (Rishabh Patel via Adrien Grand)
Other
* LUCENE-4787: Fixed some highlighting javadocs. (Michael Dodsworth via Adrien
Grand)
======================= Lucene 6.1.0 =======================

2
lucene/highlighter/src/java/org/apache/lucene/search/highlight/GradientFormatter.java
View File

@ -40,7 +40,7 @@ public class GradientFormatter implements Formatter
* Sets the color range for the IDF scores
*
* @param maxScore
* The score (and above) displayed as maxColor (See QueryScorer.getMaxWeight
* The score (and above) displayed as maxColor (See {@link QueryScorer#getMaxTermWeight()}
* which can be used to calibrate scoring scale)
* @param minForegroundColor
* The hex color used for representing IDF scores of zero eg

4
lucene/highlighter/src/java/org/apache/lucene/search/highlight/package-info.java
View File

@ -86,10 +86,10 @@
* A subtle use of color can help emphasise the reasons for matching (useful when doing "MoreLikeThis" queries and
* you want to see what the basis of the similarities are).</p>
*
* <p>The QueryScorer class has a new constructor which can use an IndexReader to derive the IDF (inverse document frequency)
* <p>The QueryScorer class has constructors that use an IndexReader to derive the IDF (inverse document frequency)
* for each term in order to influence the score. This is useful for helping to extracting the most significant sections
* of a document and in supplying scores used by the new GradientFormatter to color significant words more strongly.
* The QueryScorer.getMaxWeight method is useful when passed to the GradientFormatter constructor to define the top score
* The QueryScorer.getMaxTermWeight method is useful when passed to the GradientFormatter constructor to define the top score
* which is associated with the top color.</p>
*/
package org.apache.lucene.search.highlight;