svn commit: r1433762 - in /lucene/dev/branches/lucene_solr_4_1: ./ lucene/ lucene/misc/ lucene/misc/src/java/org/apache/lucene/misc/HighFreqTerms.java

[sa...@apache.org]

Author: sarowe
Date: Wed Jan 16 00:20:16 2013
New Revision: 1433762

URL: http://svn.apache.org/viewvc?rev=1433762&view=rev
Log:
cleaned up class javadoc

Modified:
    lucene/dev/branches/lucene_solr_4_1/   (props changed)
    lucene/dev/branches/lucene_solr_4_1/lucene/   (props changed)
    lucene/dev/branches/lucene_solr_4_1/lucene/misc/   (props changed)
    lucene/dev/branches/lucene_solr_4_1/lucene/misc/src/java/org/apache/lucene/misc/HighFreqTerms.java

Modified: lucene/dev/branches/lucene_solr_4_1/lucene/misc/src/java/org/apache/lucene/misc/HighFreqTerms.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene_solr_4_1/lucene/misc/src/java/org/apache/lucene/misc/HighFreqTerms.java?rev=1433762&r1=1433761&r2=1433762&view=diff
==============================================================================
--- lucene/dev/branches/lucene_solr_4_1/lucene/misc/src/java/org/apache/lucene/misc/HighFreqTerms.java (original)
+++ lucene/dev/branches/lucene_solr_4_1/lucene/misc/src/java/org/apache/lucene/misc/HighFreqTerms.java Wed Jan 16 00:20:16 2013
@@ -40,11 +40,13 @@ import java.util.Arrays;
 import java.util.Comparator;
 
 /**
- * 
  * <code>HighFreqTerms</code> class extracts the top n most frequent terms
- * (by document frequency ) from an existing Lucene index and reports their document frequencey.
- * If the -t flag is  and reports both their document frequency and their total tf (total number of occurences) 
- * in order of highest total tf
+ * (by document frequency) from an existing Lucene index and reports their
+ * document frequency.
+ * <p>
+ * If the -t flag is given, both document frequency and total tf (total
+ * number of occurrences) are reported, ordered by descending total tf.
+ *
  */
 public class HighFreqTerms {