From feddbabf803512fcca88f98a21a38638ba7e910e Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Thu, 25 Oct 2012 01:57:46 +0000 Subject: [PATCH] fix and detect invalid html tags in javadocs git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1401947 13f79535-47bb-0310-9956-ffa450edef68 --- .../benchmark/byTask/feeds/TrecDocParser.java | 2 +- lucene/build.xml | 9 ++++++++- lucene/common-build.xml | 19 +++++++++++++++++++ .../apache/lucene/index/IndexableField.java | 2 +- .../index/OrdinalMappingAtomicReader.java | 2 +- .../streaming/CategoryAttributesStream.java | 2 +- solr/build.xml | 6 ++++++ .../solr/handler/dataimport/Context.java | 2 +- .../dataimport/FieldReaderDataSource.java | 2 +- .../handler/dataimport/XPathRecordReader.java | 6 +++--- .../handler/extraction/ExtractingParams.java | 2 +- .../solr/search/SurroundQParserPlugin.java | 4 ++-- .../solr/servlet/SolrDispatchFilter.java | 12 ++++++++---- 13 files changed, 53 insertions(+), 17 deletions(-) diff --git a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/TrecDocParser.java b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/TrecDocParser.java index 9f0dd36e17f..8e24f72983b 100644 --- a/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/TrecDocParser.java +++ b/lucene/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/TrecDocParser.java @@ -24,7 +24,7 @@ import java.util.Locale; import java.util.Map; /** - * Parser for trec doc content, invoked on doc text excluding and + * Parser for trec doc content, invoked on doc text excluding <DOC> and <DOCNO> * which are handled in TrecContentSource. Required to be stateless and hence thread safe. */ public abstract class TrecDocParser { diff --git a/lucene/build.xml b/lucene/build.xml index a8db45533a8..e61d8d13eec 100644 --- a/lucene/build.xml +++ b/lucene/build.xml @@ -228,9 +228,16 @@ - + + + + + + diff --git a/lucene/common-build.xml b/lucene/common-build.xml index 9f142453228..a965efc4ffc 100644 --- a/lucene/common-build.xml +++ b/lucene/common-build.xml @@ -1565,6 +1565,25 @@ ${tests-output}/junit4-*.suites - per-JVM executed suites + + + + + + + + + + + + + + + + + diff --git a/lucene/core/src/java/org/apache/lucene/index/IndexableField.java b/lucene/core/src/java/org/apache/lucene/index/IndexableField.java index 062dc8c427a..ec8e691dc23 100644 --- a/lucene/core/src/java/org/apache/lucene/index/IndexableField.java +++ b/lucene/core/src/java/org/apache/lucene/index/IndexableField.java @@ -31,7 +31,7 @@ import org.apache.lucene.util.BytesRef; // TODO: we need to break out separate StoredField... /** Represents a single field for indexing. IndexWriter - * consumes Iterable as a document. + * consumes Iterable<IndexableField> as a document. * * @lucene.experimental */ diff --git a/lucene/facet/src/java/org/apache/lucene/facet/index/OrdinalMappingAtomicReader.java b/lucene/facet/src/java/org/apache/lucene/facet/index/OrdinalMappingAtomicReader.java index 9b69e7b8725..0e0976fbb4e 100644 --- a/lucene/facet/src/java/org/apache/lucene/facet/index/OrdinalMappingAtomicReader.java +++ b/lucene/facet/src/java/org/apache/lucene/facet/index/OrdinalMappingAtomicReader.java @@ -59,7 +59,7 @@ import org.apache.lucene.util.encoding.IntEncoder; * DirectoryReader reader = DirectoryReader.open(oldDir); * IndexWriterConfig conf = new IndexWriterConfig(VER, ANALYZER); * IndexWriter writer = new IndexWriter(newDir, conf); - * List leaves = reader.leaves(); + * List<AtomicReaderContext> leaves = reader.leaves(); * AtomicReader wrappedLeaves[] = new AtomicReader[leaves.size()]; * for (int i = 0; i < leaves.size(); i++) { * wrappedLeaves[i] = new OrdinalMappingAtomicReader(leaves.get(i).reader(), ordmap); diff --git a/lucene/facet/src/java/org/apache/lucene/facet/index/streaming/CategoryAttributesStream.java b/lucene/facet/src/java/org/apache/lucene/facet/index/streaming/CategoryAttributesStream.java index 7d076554b71..5a053fff555 100644 --- a/lucene/facet/src/java/org/apache/lucene/facet/index/streaming/CategoryAttributesStream.java +++ b/lucene/facet/src/java/org/apache/lucene/facet/index/streaming/CategoryAttributesStream.java @@ -32,7 +32,7 @@ import org.apache.lucene.facet.index.attributes.CategoryAttribute; *

* A CategoryAttributesStream object can be reused for producing more than one * stream. To do that, the user should cause the underlying - * Iterable object to return a new set of categories, and + * Iterable<CategoryAttribute> object to return a new set of categories, and * then call {@link #reset()} to allow this stream to be used again. * * @lucene.experimental diff --git a/solr/build.xml b/solr/build.xml index 9fe322ce4f5..06c0ffe3e29 100644 --- a/solr/build.xml +++ b/solr/build.xml @@ -526,6 +526,12 @@ + + + + diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java index a86c13c3096..325138fa7ae 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java @@ -87,7 +87,7 @@ public abstract class Context { /** * Returns the VariableResolver used in this entity which can be used to - * resolve the tokens in ${} + * resolve the tokens in ${<namespce.name>} * * @return a VariableResolver instance * @see org.apache.solr.handler.dataimport.VariableResolver diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/FieldReaderDataSource.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/FieldReaderDataSource.java index 6f8ebb735be..bbe9bdcb8d9 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/FieldReaderDataSource.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/FieldReaderDataSource.java @@ -32,7 +32,7 @@ import java.util.Properties; *

* The datasouce may be configured as follows *

- * + * <datasource name="f1" type="FieldReaderDataSource" /> *

* The enity which uses this datasource must keep the url value as the variable name url="field-name" *

diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java index 50d42ccef04..7697e0d5994 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java @@ -45,7 +45,7 @@ import org.slf4j.LoggerFactory; * /a/b/c * * A record is a Map<String,Object> . The key is the provided name - * and the value is a String or a List + * and the value is a String or a List<String> * * This class is thread-safe for parsing xml. But adding fields is not * thread-safe. The recommended usage is to addField() in one thread and @@ -651,10 +651,10 @@ public class XPathRecordReader { /** * @param record The record map. The key is the field name as provided in * the addField() methods. The value can be a single String (for single - * valued fields) or a List (for multiValued). + * valued fields) or a List<String> (for multiValued). * @param xpath The forEach XPATH for which this record is being emitted * If there is any change all parsing will be aborted and the Exception - * is propogated up + * is propagated up */ public void handle(Map record, String xpath); } diff --git a/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/ExtractingParams.java b/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/ExtractingParams.java index a229b522df4..60d53822a2e 100644 --- a/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/ExtractingParams.java +++ b/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/ExtractingParams.java @@ -159,7 +159,7 @@ public interface ExtractingParams { * File format is Java properties format with one key=value per line. * The key is evaluated as a regex against the file name, and the value is the password * The rules are evaluated top-bottom, i.e. the first match will be used - * If you want a fallback password to be always used, supply a .*= at the end + * If you want a fallback password to be always used, supply a .*=<defaultmypassword> at the end */ public static final String PASSWORD_MAP_FILE = "passwordsFile"; } 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 d7ba2a67524..3b20a6153a6 100644 --- a/solr/core/src/java/org/apache/solr/search/SurroundQParserPlugin.java +++ b/solr/core/src/java/org/apache/solr/search/SurroundQParserPlugin.java @@ -34,8 +34,8 @@ import org.slf4j.LoggerFactory; * Plugin for lucene/contrib Surround query parser, bringing SpanQuery support * to Solr * - * + * <queryParser name="surround" + * class="org.apache.solr.search.SurroundQParserPlugin" /> * * Examples of query syntax can be found in lucene/queryparser/docs/surround * diff --git a/solr/core/src/java/org/apache/solr/servlet/SolrDispatchFilter.java b/solr/core/src/java/org/apache/solr/servlet/SolrDispatchFilter.java index 8c2ce1dd5e5..0723ccf1d97 100644 --- a/solr/core/src/java/org/apache/solr/servlet/SolrDispatchFilter.java +++ b/solr/core/src/java/org/apache/solr/servlet/SolrDispatchFilter.java @@ -493,20 +493,24 @@ public class SolrDispatchFilter implements Filter * filter into a larger web application. * * For example, if web.xml specifies: - * + * 

+   * {@code
    * 
    *  SolrRequestFilter
    *  /xxx/*
-   * 
+   * }
+   *
* * Make sure to set the PathPrefix to "/xxx" either with this function * or in web.xml. * + * 
+   * {@code
    * 
    *  path-prefix
    *  /xxx
-   * 
-   *
+   * }
+   *
*/ public void setPathPrefix(String pathPrefix) { this.pathPrefix = pathPrefix;