From 25eab66662fe05c5453330f5bb341d8b00299661 Mon Sep 17 00:00:00 2001
From: Robert Muir <rmuir@apache.org>
Date: Wed, 7 Nov 2012 04:29:25 +0000
Subject: [PATCH] try to fix the worst of the class summaries so that the first
 sentence is parsed correctly

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1406454 13f79535-47bb-0310-9956-ffa450edef68
---
 .../solr/client/solrj/embedded/EmbeddedSolrServer.java   | 4 ++--
 .../java/org/apache/solr/core/MMapDirectoryFactory.java  | 4 ++--
 .../solr/handler/admin/ShowFileRequestHandler.java       | 8 ++++----
 .../apache/solr/handler/component/FieldFacetStats.java   | 3 ++-
 .../apache/solr/response/BinaryQueryResponseWriter.java  | 3 ++-
 .../apache/solr/schema/OpenExchangeRatesOrgProvider.java | 2 +-
 .../src/java/org/apache/solr/search/DisMaxQParser.java   | 2 +-
 .../src/java/org/apache/solr/search/QueryParsing.java    | 2 +-
 .../java/org/apache/solr/search/SolrFieldCacheMBean.java | 3 +--
 .../org/apache/solr/search/SurroundQParserPlugin.java    | 9 ++++-----
 .../org/apache/solr/update/DirectUpdateHandler2.java     | 4 ++--
 .../client/solrj/request/ContentStreamUpdateRequest.java | 2 +-
 .../java/org/apache/solr/common/params/FacetParams.java  | 2 +-
 13 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java b/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java
index ecb38e72df5..f55d3f2ac8a 100644
--- a/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java
+++ b/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java
@@ -46,8 +46,8 @@ import org.apache.solr.response.SolrQueryResponse;
 import org.apache.solr.servlet.SolrRequestParsers;
 
 /**
- * SolrServer that connects directly to SolrCore
- * 
+ * SolrServer that connects directly to SolrCore.
+ * <p>
  * TODO -- this implementation sends the response to XML and then parses it.  
  * It *should* be able to convert the response directly into a named list.
  * 
diff --git a/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java b/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java
index 97644e84a5a..1736a0378ba 100644
--- a/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java
+++ b/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java
@@ -30,8 +30,8 @@ import java.io.IOException;
 
 
 /**
- *  Directly provide MMapDirectory instead of relying on {@link org.apache.lucene.store.FSDirectory#open}
- *
+ * Directly provide MMapDirectory instead of relying on {@link org.apache.lucene.store.FSDirectory#open}.
+ * <p>
  * Can set the following parameters:
  * <ul>
  *  <li>unmap -- See {@link MMapDirectory#setUseUnmap(boolean)}</li>
diff --git a/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java b/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java
index fe397eca1bf..ba74e93a589 100644
--- a/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java
+++ b/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java
@@ -48,11 +48,11 @@ import java.util.Set;
 /**
  * This handler uses the RawResponseWriter to give client access to
  * files inside ${solr.home}/conf
- * 
+ * <p>
  * If you want to selectively restrict access some configuration files, you can list
  * these files in the {@link #HIDDEN} invariants.  For example to hide 
  * synonyms.txt and anotherfile.txt, you would register:
- * 
+ * <p>
  * <pre>
  * &lt;requestHandler name="/admin/file" class="org.apache.solr.handler.admin.ShowFileRequestHandler" &gt;
  *   &lt;lst name="defaults"&gt;
@@ -64,11 +64,11 @@ import java.util.Set;
  *   &lt;/lst&gt;
  * &lt;/requestHandler&gt;
  * </pre>
- * 
+ * <p>
  * The ShowFileRequestHandler uses the {@link RawResponseWriter} (wt=raw) to return
  * file contents.  If you need to use a different writer, you will need to change 
  * the registered invariant param for wt.
- * 
+ * <p>
  * If you want to override the contentType header returned for a given file, you can
  * set it directly using: {@link #USE_CONTENT_TYPE}.  For example, to get a plain text
  * version of schema.xml, try:
diff --git a/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java b/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java
index 8450cac8acd..99eb6566cb9 100644
--- a/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java
+++ b/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java
@@ -28,9 +28,10 @@ import java.util.Map;
 
 
 /**
- * 9/10/2009 - Moved out of StatsComponent to allow open access to UnInvertedField
  * FieldFacetStats is a utility to accumulate statistics on a set of values in one field,
  * for facet values present in another field.
+ * <p>
+ * 9/10/2009 - Moved out of StatsComponent to allow open access to UnInvertedField
  * <p/>
  * @see org.apache.solr.handler.component.StatsComponent
  *
diff --git a/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java b/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java
index 7df54e183e5..9273b0a1980 100755
--- a/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java
+++ b/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java
@@ -24,7 +24,8 @@ import org.apache.solr.request.SolrQueryRequest;
 
 /**
  * Implementations of <code>BinaryQueryResponseWriter</code> are used to
- * write response in binary format
+ * write response in binary format.
+ * <p>
  * Functionality is exactly same as its parent class <code>QueryResponseWriter</code>
  * But it may not implement the <code>write(Writer writer, SolrQueryRequest request, SolrQueryResponse response)</code>
  * method  
diff --git a/solr/core/src/java/org/apache/solr/schema/OpenExchangeRatesOrgProvider.java b/solr/core/src/java/org/apache/solr/schema/OpenExchangeRatesOrgProvider.java
index fed32408c70..7b149c7f420 100644
--- a/solr/core/src/java/org/apache/solr/schema/OpenExchangeRatesOrgProvider.java
+++ b/solr/core/src/java/org/apache/solr/schema/OpenExchangeRatesOrgProvider.java
@@ -35,7 +35,7 @@ import org.slf4j.LoggerFactory;
 /**
  * Exchange Rates Provider for {@link CurrencyField} implementing the freely available
  * exchange rates from openexchangerates.org
- * <p/>
+ * <p>
  * <b>Disclaimer:</b> This data is collected from various providers and provided free of charge
  * for informational purposes only, with no guarantee whatsoever of accuracy, validity,
  * availability or fitness for any purpose; use at your own risk. Other than that - have
diff --git a/solr/core/src/java/org/apache/solr/search/DisMaxQParser.java b/solr/core/src/java/org/apache/solr/search/DisMaxQParser.java
index 580b9e2a10e..f02a061d0ba 100644
--- a/solr/core/src/java/org/apache/solr/search/DisMaxQParser.java
+++ b/solr/core/src/java/org/apache/solr/search/DisMaxQParser.java
@@ -35,7 +35,7 @@ import java.util.Map;
 
 /**
  * Query parser for dismax queries
- * <p/>
+ * <p>
  * <b>Note: This API is experimental and may change in non backward-compatible ways in the future</b>
  *
  *
diff --git a/solr/core/src/java/org/apache/solr/search/QueryParsing.java b/solr/core/src/java/org/apache/solr/search/QueryParsing.java
index 5c8e162ab0c..48098254064 100644
--- a/solr/core/src/java/org/apache/solr/search/QueryParsing.java
+++ b/solr/core/src/java/org/apache/solr/search/QueryParsing.java
@@ -573,7 +573,7 @@ public class QueryParsing {
   }
 
   /**
-   * Simple class to help with parsing a string
+   * Simple class to help with parsing a string.
    * <b>Note: This API is experimental and may change in non backward-compatible ways in the future</b>
    */
   public static class StrParser {
diff --git a/solr/core/src/java/org/apache/solr/search/SolrFieldCacheMBean.java b/solr/core/src/java/org/apache/solr/search/SolrFieldCacheMBean.java
index 7c2fe864708..119f858c461 100644
--- a/solr/core/src/java/org/apache/solr/search/SolrFieldCacheMBean.java
+++ b/solr/core/src/java/org/apache/solr/search/SolrFieldCacheMBean.java
@@ -31,8 +31,7 @@ import org.apache.lucene.util.FieldCacheSanityChecker;
 import org.apache.lucene.util.FieldCacheSanityChecker.Insanity;
 
 /**
- * A SolrInfoMBean that provides introspection of the Lucene FiledCache, this is <b>NOT</b> a cache that is manged by Solr.
- *
+ * A SolrInfoMBean that provides introspection of the Lucene FieldCache, this is <b>NOT</b> a cache that is managed by Solr.
  *
  */
 public class SolrFieldCacheMBean implements SolrInfoMBean {
diff --git a/solr/core/src/java/org/apache/solr/search/SurroundQParserPlugin.java b/solr/core/src/java/org/apache/solr/search/SurroundQParserPlugin.java
index 3b20a6153a6..f5dad7cb6a2 100644
--- a/solr/core/src/java/org/apache/solr/search/SurroundQParserPlugin.java
+++ b/solr/core/src/java/org/apache/solr/search/SurroundQParserPlugin.java
@@ -32,15 +32,14 @@ import org.slf4j.LoggerFactory;
 
 /**
  * Plugin for lucene/contrib Surround query parser, bringing SpanQuery support
- * to Solr
- * 
+ * to Solr.
+ * <p>
  * &lt;queryParser name="surround"
  * class="org.apache.solr.search.SurroundQParserPlugin" /&gt;
- * 
- * Examples of query syntax can be found in lucene/queryparser/docs/surround
- * 
+ * <p>
  * Note that the query string is not analyzed in any way
  * 
+ * @see QueryParser
  * @since 4.0
  */
 
diff --git a/solr/core/src/java/org/apache/solr/update/DirectUpdateHandler2.java b/solr/core/src/java/org/apache/solr/update/DirectUpdateHandler2.java
index f4d58b78a75..5589e052b6c 100644
--- a/solr/core/src/java/org/apache/solr/update/DirectUpdateHandler2.java
+++ b/solr/core/src/java/org/apache/solr/update/DirectUpdateHandler2.java
@@ -63,10 +63,10 @@ import org.apache.solr.search.function.ValueSourceRangeFilter;
 import org.apache.solr.util.RefCounted;
 
 /**
- *  TODO: add soft commitWithin support
- * 
  * <code>DirectUpdateHandler2</code> implements an UpdateHandler where documents are added
  * directly to the main Lucene index as opposed to adding to a separate smaller index.
+ * <p>
+ * TODO: add soft commitWithin support
  */
 public class DirectUpdateHandler2 extends UpdateHandler implements SolrCoreState.IndexWriterCloser {
   protected final SolrCoreState solrCoreState;
diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java b/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java
index de9886b30a5..c9d464d6126 100644
--- a/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java
+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java
@@ -30,7 +30,7 @@ import java.util.List;
 /**
  * Basic functionality to upload a File or {@link org.apache.solr.common.util.ContentStream} to a Solr Cell or some
  * other handler that takes ContentStreams (CSV)
- * <p/>
+ * <p>
  * See http://wiki.apache.org/solr/ExtractingRequestHandler<br/>
  * See http://wiki.apache.org/solr/UpdateCSV
  * 
diff --git a/solr/solrj/src/java/org/apache/solr/common/params/FacetParams.java b/solr/solrj/src/java/org/apache/solr/common/params/FacetParams.java
index 135db223927..8b8c0022566 100644
--- a/solr/solrj/src/java/org/apache/solr/common/params/FacetParams.java
+++ b/solr/solrj/src/java/org/apache/solr/common/params/FacetParams.java
@@ -297,7 +297,7 @@ public interface FacetParams {
   
   /**
    * An enumeration of the legal values for {@link #FACET_DATE_INCLUDE} and {@link #FACET_RANGE_INCLUDE}
-   *
+   * <p>
    * <ul>
    * <li>lower = all gap based ranges include their lower bound</li>
    * <li>upper = all gap based ranges include their upper bound</li>