You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by mi...@apache.org on 2013/10/20 12:49:59 UTC
svn commit: r1533876 - in /lucene/dev/branches/branch_4x: ./ lucene/
lucene/facet/
lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java
Author: mikemccand
Date: Sun Oct 20 10:49:59 2013
New Revision: 1533876
URL: http://svn.apache.org/r1533876
Log:
improve javadocs
Modified:
lucene/dev/branches/branch_4x/ (props changed)
lucene/dev/branches/branch_4x/lucene/ (props changed)
lucene/dev/branches/branch_4x/lucene/facet/ (props changed)
lucene/dev/branches/branch_4x/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java
Modified: lucene/dev/branches/branch_4x/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java?rev=1533876&r1=1533875&r2=1533876&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java (original)
+++ lucene/dev/branches/branch_4x/lucene/facet/src/java/org/apache/lucene/facet/sortedset/SortedSetDocValuesFacetFields.java Sun Oct 20 10:49:59 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 {