add more missing javadocs

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1377758 13f79535-47bb-0310-9956-ffa450edef68

lucene/queries/src/java/org/apache/lucene/queries/function/valuesource/ShortFieldSource.java

@@ -25,8 +25,9 @@ import org.apache.lucene.search.FieldCache;
 
 
 /**
- *
+ * Obtains short field values from the {@link org.apache.lucene.search.FieldCache}
- *
+ * using <code>getShorts()</code>
+ * and makes those values available as other numeric types, casting as needed.
  **/
 public class ShortFieldSource extends FieldCacheSource {
 

lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/DistanceSubQuery.java

@@ -18,6 +18,10 @@ package org.apache.lucene.queryparser.surround.query;
 
 import java.io.IOException;
 
+/**
+ * Interface for queries that can be nested as subqueries
+ * into a span near.
+ */
 public interface DistanceSubQuery {
   /** When distanceSubQueryNotAllowed() returns non null, the reason why the subquery
    * is not allowed as a distance subquery is returned.

lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/FieldsQuery.java

@@ -22,6 +22,9 @@ import java.util.Iterator;
 
 import org.apache.lucene.search.Query;
 
+/**
+ * Forms an OR query of the provided query across multiple fields.
+ */
 public class FieldsQuery extends SrndQuery { /* mostly untested */
   private SrndQuery q;
   private List<String> fieldNames;

lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/NotQuery.java

@@ -21,6 +21,9 @@ import org.apache.lucene.search.Query;
 import org.apache.lucene.search.BooleanQuery;
 import org.apache.lucene.search.BooleanClause;
 
+/**
+ * Factory for prohibited clauses
+ */
 public class NotQuery extends ComposedQuery { 
   public NotQuery(List<SrndQuery> queries, String opName) { super(queries, true /* infix */, opName); }
   

lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SimpleTerm.java

@@ -22,6 +22,9 @@ import org.apache.lucene.index.IndexReader;
 import org.apache.lucene.index.Term;
 import org.apache.lucene.search.Query;
 
+/**
+ * Base class for queries that expand to sets of simple terms.
+ */
 public abstract class SimpleTerm
   extends SrndQuery
   implements DistanceSubQuery, Comparable<SimpleTerm>
@@ -67,6 +70,10 @@ public abstract class SimpleTerm
                             String fieldName,
                             MatchingTermVisitor mtv) throws IOException;
   
+  /**
+   * Callback to visit each matching term during "rewrite"
+   * in {@link #visitMatchingTerm(Term)}
+   */
   public interface MatchingTermVisitor {
     void visitMatchingTerm(Term t)throws IOException;
   }

lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndPrefixQuery.java

@@ -27,6 +27,9 @@ import org.apache.lucene.index.MultiFields;
 import java.io.IOException;
 
 
+/**
+ * Query that matches String prefixes
+ */
 public class SrndPrefixQuery extends SimpleTerm {
   private final BytesRef prefixRef;
   public SrndPrefixQuery(String prefix, boolean quoted, char truncator) {

lucene/queryparser/src/java/org/apache/lucene/queryparser/surround/query/SrndTermQuery.java

@@ -26,6 +26,9 @@ import org.apache.lucene.index.MultiFields;
 import org.apache.lucene.util.BytesRef;
 
  
+/**
+ * Simple single-term clause
+ */
 public class SrndTermQuery extends SimpleTerm {
   public SrndTermQuery(String termText, boolean quoted) {
     super(quoted);

lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/CorePlusExtensionsParser.java

@@ -22,7 +22,9 @@ import org.apache.lucene.queryparser.xml.builders.*;
  */
 
 /**
- *
+ * Assembles a QueryBuilder which uses Query objects from
+ * Lucene's <code>sandbox</code> and <code>queries</code>
+ * modules in addition to core queries.
  */
 public class CorePlusExtensionsParser extends CoreParser {
 

lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/DOMUtils.java

@@ -26,7 +26,7 @@ import java.io.Reader;
  */
 
 /**
- *
+ * Helper methods for parsing XML
  */
 public class DOMUtils {
 

lucene/queryparser/src/java/org/apache/lucene/queryparser/xml/ParserException.java

@@ -20,7 +20,8 @@ package org.apache.lucene.queryparser.xml;
  */
 
 /**
- * 
+ * Thrown when the xml queryparser encounters 
+ * invalid syntax/configuration.
  */
 public class ParserException extends Exception {
 

lucene/spatial/src/java/org/apache/lucene/spatial/util/CachingDoubleValueSource.java

@@ -26,6 +26,8 @@ import java.util.HashMap;
 import java.util.Map;
 
 /**
+ * Caches the doubleVal of another value source in a HashMap
+ * so that it is computed only once.
  * @lucene.internal
  */
 public class CachingDoubleValueSource extends ValueSource {

lucene/spatial/src/java/org/apache/lucene/spatial/util/ValueSourceFilter.java

@@ -28,6 +28,8 @@ import org.apache.lucene.util.Bits;
 import java.io.IOException;
 
 /**
+ * Filter that matches all documents where a valuesource is
+ * in between a range of <code>min</code> and <code>max</code>
  * @lucene.internal
  */
 public class ValueSourceFilter extends Filter {