svn commit: r1368477 - in /lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene: codecs/bloom/BloomFilterFactory.java util/FuzzySet.java

[mh...@apache.org]

Author: mharwood
Date: Thu Aug  2 14:04:19 2012
New Revision: 1368477

URL: http://svn.apache.org/viewvc?rev=1368477&view=rev
Log:
Javadoc fixes

Modified:
    lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/bloom/BloomFilterFactory.java
    lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/FuzzySet.java

Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/bloom/BloomFilterFactory.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/bloom/BloomFilterFactory.java?rev=1368477&r1=1368476&r2=1368477&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/bloom/BloomFilterFactory.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/bloom/BloomFilterFactory.java Thu Aug  2 14:04:19 2012
@@ -54,9 +54,9 @@ public abstract class BloomFilterFactory
 
   /**
    * Used to determine if the given filter has reached saturation and should be retired i.e. not saved any more
-   * @param bloomFilter
-   * @param fieldInfo
-   * @return
+   * @param bloomFilter The bloomFilter being tested
+   * @param fieldInfo The field with which this filter is associated
+   * @return true if the set has reached saturation and should be retired
    */
   public abstract boolean isSaturated(FuzzySet bloomFilter, FieldInfo fieldInfo);
   

Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/FuzzySet.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/FuzzySet.java?rev=1368477&r1=1368476&r2=1368477&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/FuzzySet.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/util/FuzzySet.java Thu Aug  2 14:04:19 2012
@@ -96,7 +96,7 @@ public class FuzzySet {
    * than deciding how much memory to throw at the problem.
    * @param maxNumberOfValuesExpected
    * @param desiredSaturation A number between 0 and 1 expressing the % of bits set once all values have been recorded
-   * @return
+   * @return The size of the set nearest to the required size
    */
   public static int getNearestSetSize(int maxNumberOfValuesExpected,
       float desiredSaturation) {
@@ -213,7 +213,7 @@ public class FuzzySet {
   /**
    * Records a value in the set. The referenced bytes are hashed and then modulo n'd where n is the
    * chosen size of the internal bitset.
-   * @param bytes
+   * @param value the key value to be hashed
    * @throws IOException
    */
   public void addValue(BytesRef value) throws IOException {    
@@ -229,7 +229,7 @@ public class FuzzySet {
   
   /**
    * 
-   * @param targetSaturation A number between 0 and 1 describing the % of bits that would ideally be set in the 
+   * @param targetMaxSaturation A number between 0 and 1 describing the % of bits that would ideally be set in the 
    * result. Lower values have better qccuracy but require more space.
    * @return a smaller FuzzySet or null if the current set is already over-saturated
    */