svn commit: r1533875 - /lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java

[mi...@apache.org]

Author: mikemccand
Date: Sun Oct 20 10:49:41 2013
New Revision: 1533875

URL: http://svn.apache.org/r1533875
Log:
improve javadocs

Modified:
    lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java

Modified: lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java?rev=1533875&r1=1533874&r2=1533875&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java (original)
+++ lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java Sun Oct 20 10:49:41 2013
@@ -31,12 +31,12 @@ import org.apache.lucene.facet.params.Fa
 import org.apache.lucene.facet.taxonomy.CategoryPath;
 import org.apache.lucene.util.BytesRef;
 
-/** Add instances of this to your Document if you intend to
+/** Use this to index facets if you intend to
  *  use {@link SortedSetDocValuesAccumulator} to count facets
  *  at search time.  Note that this only supports flat
- *  facets (dimension + label).  Add multiple instances of
- *  this to your document, one per dimension + label, and
- *  it's fine if a given dimension is multi-valued. */
+ *  facets (dimension + label).  Instantiate this class
+ *  once, and then call {@link #addFields} to add the
+ *  necessary fields to each {@link Document}. */
 
 public class SortedSetDocValuesFacetFields extends FacetFields {