svn commit: r1410421 - in /lucene/dev/branches/branch_4x: ./ lucene/ lucene/core/ lucene/core/src/java/org/apache/lucene/util/fst/Builder.java

[mi...@apache.org]

Author: mikemccand
Date: Fri Nov 16 16:00:03 2012
New Revision: 1410421

URL: http://svn.apache.org/viewvc?rev=1410421&view=rev
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/core/   (props changed)
    lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/fst/Builder.java

Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/fst/Builder.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/fst/Builder.java?rev=1410421&r1=1410420&r2=1410421&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/fst/Builder.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/fst/Builder.java Fri Nov 16 16:00:03 2012
@@ -136,9 +136,9 @@ public class Builder<T> {
    *    singleton output object.
    *
    * @param willPackFST Pass true if you will pack the FST before saving.  This
-   *    causes the FST to create additional data structures internally to facilitate packing, but
-   *    it means the resulting FST cannot be saved: it must
-   *    first be packed using {@link FST#pack(int, int, float)}
+   *    causes the FST to create additional data structures internally to enable packing, but
+   *    it means the resulting FST cannot be saved until it
+   *    is packed using {@link FST#pack(int, int, float)}
    *
    * @param acceptableOverheadRatio How to trade speed for space when building the FST. This option
    *    is only relevant when willPackFST is true. @see PackedInts#getMutable(int, int, float)