LUCENE-3902: add missing javadocs to remaining classes

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

lucene/build.xml

@@ -228,39 +228,39 @@
   <target name="documentation-lint" depends="documentation">
     <sequential>
       <check-broken-links dir="build/docs"/>
-      <!-- TODO: change this level=class -->
-      <check-missing-javadocs dir="build/docs" level="package"/>
+      <!-- TODO: change this level=method -->
+      <check-missing-javadocs dir="build/docs" level="class"/>
       <!-- too many classes to fix overall to just enable
-           the above to be level="class" right now, but we
+           the above to be level="method" right now, but we
            can prevent the modules that don't have problems
            from getting any worse -->
-      <check-missing-javadocs dir="build/docs/analyzers-common" level="class"/>
+      <!-- analyzers-common: problems -->
       <check-missing-javadocs dir="build/docs/analyzers-icu" level="method"/>
-      <check-missing-javadocs dir="build/docs/analyzers-kuromoji" level="class"/>
+      <!-- analyzers-kuromoji: problems -->
       <check-missing-javadocs dir="build/docs/analyzers-morfologik" level="method"/>
       <check-missing-javadocs dir="build/docs/analyzers-phonetic" level="method"/>
-      <check-missing-javadocs dir="build/docs/analyzers-smartcn" level="class"/>
+      <!-- analyzers-smartcn: problems -->
       <check-missing-javadocs dir="build/docs/analyzers-stempel" level="method"/>
-      <check-missing-javadocs dir="build/docs/analyzers-uima" level="class"/>
-      <check-missing-javadocs dir="build/docs/benchmark" level="class"/>
+      <!-- analyzers-uima: problems -->
+      <!-- benchmark: problems -->
       <check-missing-javadocs dir="build/docs/classification" level="method"/>
-      <check-missing-javadocs dir="build/docs/codecs" level="class"/>
-      <check-missing-javadocs dir="build/docs/core" level="class"/>
+      <!-- codecs: problems -->
+      <!-- core: problems -->
       <check-missing-javadocs dir="build/docs/demo" level="method"/>
-      <check-missing-javadocs dir="build/docs/facet" level="class"/>
-      <check-missing-javadocs dir="build/docs/grouping" level="class"/>
-      <check-missing-javadocs dir="build/docs/highlighter" level="class"/>
+      <!-- facet: problems -->
+      <!-- grouping: problems -->
+      <!-- highlighter: problems -->
       <check-missing-javadocs dir="build/docs/join" level="method"/>
       <check-missing-javadocs dir="build/docs/memory" level="method"/>
-      <check-missing-javadocs dir="build/docs/misc" level="class"/>
-      <check-missing-javadocs dir="build/docs/queries" level="class"/>
+      <!-- misc: problems -->
+      <!-- queries: problems -->
       <!-- queryparser: problems -->
-      <check-missing-javadocs dir="build/docs/sandbox" level="class"/>
-      <check-missing-javadocs dir="build/docs/spatial" level="class"/>
-      <check-missing-javadocs dir="build/docs/suggest" level="class"/>
-      <check-missing-javadocs dir="build/docs/test-framework" level="class"/>
+      <!-- sandbox: problems -->
+      <!-- spatial: problems -->
+      <!-- suggest: problems -->
+      <!-- test-framework: problems -->
 
-      <!-- too much to fix for now, but enforce full javadocs for key packages -->
+      <!-- too much to fix core/ for now, but enforce full javadocs for key packages -->
       <check-missing-javadocs dir="build/docs/core/org/apache/lucene/analysis" level="method"/>
       <check-missing-javadocs dir="build/docs/core/org/apache/lucene/document" level="method"/>
       <check-missing-javadocs dir="build/docs/core/org/apache/lucene/search/similarities" level="method"/>

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

@@ -29,6 +29,7 @@ import org.apache.lucene.index.Term;
 import org.apache.lucene.search.TermQuery;
 import org.apache.lucene.search.spans.SpanTermQuery;
 
+/** Factory for creating basic term queries */
 public class BasicQueryFactory {
   public BasicQueryFactory(int maxBasicQueries) {
     this.maxBasicQueries = maxBasicQueries;

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

@@ -22,6 +22,7 @@ import java.util.Iterator;
 
 import org.apache.lucene.search.Query;
 
+/** Base class for composite queries (such as AND/OR/NOT) */
 public abstract class ComposedQuery extends SrndQuery { 
   
   public ComposedQuery(List<SrndQuery> qs, boolean operatorInfix, String opName) {

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

@@ -26,6 +26,7 @@ import org.apache.lucene.search.Query;
 import org.apache.lucene.search.spans.SpanNearQuery;
 import org.apache.lucene.search.spans.SpanQuery;
 
+/** Factory for NEAR queries */
 public class DistanceQuery extends ComposedQuery implements DistanceSubQuery {
   public DistanceQuery(
       List<SrndQuery> queries,

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

@@ -20,6 +20,7 @@ import org.apache.lucene.search.BooleanClause;
 import org.apache.lucene.search.BooleanQuery;
 import org.apache.lucene.search.Query;
 
+/** Lowest level base class for surround queries */
 public abstract class SrndQuery implements Cloneable {
   public SrndQuery() {}
   

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

@@ -29,7 +29,9 @@ import java.io.IOException;
 import java.util.regex.Pattern;
 import java.util.regex.Matcher;
 
-
+/**
+ * Query that matches wildcards
+ */
 public class SrndTruncQuery extends SimpleTerm {
   public SrndTruncQuery(String truncated, char unlimited, char mask) {
     super(false); /* not quoted */