You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/11/07 05:32:16 UTC
svn commit: r1406457 - in /lucene/dev/branches/branch_4x: ./ solr/
solr/core/ solr/core/src/java/org/apache/solr/client/solrj/embedded/
solr/core/src/java/org/apache/solr/core/
solr/core/src/java/org/apache/solr/handler/admin/
solr/core/src/java/org/ap...
Author: rmuir
Date: Wed Nov 7 04:32:16 2012
New Revision: 1406457
URL: http://svn.apache.org/viewvc?rev=1406457&view=rev
Log:
try to fix the worst of the class summaries so that the first sentence is parsed correctly
Modified:
lucene/dev/branches/branch_4x/ (props changed)
lucene/dev/branches/branch_4x/solr/ (props changed)
lucene/dev/branches/branch_4x/solr/core/ (props changed)
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/schema/OpenExchangeRatesOrgProvider.java
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/DisMaxQParser.java
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/QueryParsing.java
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/SolrFieldCacheMBean.java
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/SurroundQParserPlugin.java
lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/update/DirectUpdateHandler2.java
lucene/dev/branches/branch_4x/solr/solrj/ (props changed)
lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java
lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/common/params/FacetParams.java
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java Wed Nov 7 04:32:16 2012
@@ -46,8 +46,8 @@ import org.apache.solr.response.SolrQuer
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.
*
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java Wed Nov 7 04:32:16 2012
@@ -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>
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java Wed Nov 7 04:32:16 2012
@@ -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>
* <requestHandler name="/admin/file" class="org.apache.solr.handler.admin.ShowFileRequestHandler" >
* <lst name="defaults">
@@ -64,11 +64,11 @@ import java.util.Set;
* </lst>
* </requestHandler>
* </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:
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java Wed Nov 7 04:32:16 2012
@@ -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
*
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java Wed Nov 7 04:32:16 2012
@@ -24,7 +24,8 @@ import org.apache.solr.request.SolrQuery
/**
* 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
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/schema/OpenExchangeRatesOrgProvider.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/schema/OpenExchangeRatesOrgProvider.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/schema/OpenExchangeRatesOrgProvider.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/schema/OpenExchangeRatesOrgProvider.java Wed Nov 7 04:32:16 2012
@@ -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
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/DisMaxQParser.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/DisMaxQParser.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/DisMaxQParser.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/DisMaxQParser.java Wed Nov 7 04:32:16 2012
@@ -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>
*
*
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/QueryParsing.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/QueryParsing.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/QueryParsing.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/QueryParsing.java Wed Nov 7 04:32:16 2012
@@ -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 {
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/SolrFieldCacheMBean.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/SolrFieldCacheMBean.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/SolrFieldCacheMBean.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/SolrFieldCacheMBean.java Wed Nov 7 04:32:16 2012
@@ -31,8 +31,7 @@ import org.apache.lucene.util.FieldCache
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 {
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/SurroundQParserPlugin.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/SurroundQParserPlugin.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/SurroundQParserPlugin.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/search/SurroundQParserPlugin.java Wed Nov 7 04:32:16 2012
@@ -32,15 +32,14 @@ import org.slf4j.LoggerFactory;
/**
* Plugin for lucene/contrib Surround query parser, bringing SpanQuery support
- * to Solr
- *
+ * to Solr.
+ * <p>
* <queryParser name="surround"
* class="org.apache.solr.search.SurroundQParserPlugin" />
- *
- * 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
*/
Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/update/DirectUpdateHandler2.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/update/DirectUpdateHandler2.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/update/DirectUpdateHandler2.java (original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/update/DirectUpdateHandler2.java Wed Nov 7 04:32:16 2012
@@ -64,10 +64,10 @@ import org.apache.solr.search.function.V
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;
Modified: lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java (original)
+++ lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java Wed Nov 7 04:32:16 2012
@@ -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
*
Modified: lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/common/params/FacetParams.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/common/params/FacetParams.java?rev=1406457&r1=1406456&r2=1406457&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/common/params/FacetParams.java (original)
+++ lucene/dev/branches/branch_4x/solr/solrj/src/java/org/apache/solr/common/params/FacetParams.java Wed Nov 7 04:32:16 2012
@@ -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>