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/04/23 15:44:04 UTC
svn commit: r1329235 - in /lucene/dev/trunk: dev-tools/scripts/ solr/
solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/
solr/core/src/java/org/apache/solr/analysis/
solr/core/src/java/org/apache/solr/core/ solr/core/src/java/o...
Author: rmuir
Date: Mon Apr 23 13:44:03 2012
New Revision: 1329235
URL: http://svn.apache.org/viewvc?rev=1329235&view=rev
Log:
LUCENE-4011: fix most broken links in solr javadocs
Modified:
lucene/dev/trunk/dev-tools/scripts/checkJavadocLinks.py
lucene/dev/trunk/solr/common-build.xml
lucene/dev/trunk/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DataSource.java
lucene/dev/trunk/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java
lucene/dev/trunk/solr/core/src/java/org/apache/solr/analysis/HTMLStripCharFilterFactory.java
lucene/dev/trunk/solr/core/src/java/org/apache/solr/core/CoreContainer.java
lucene/dev/trunk/solr/core/src/java/org/apache/solr/handler/component/SearchHandler.java
lucene/dev/trunk/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java
lucene/dev/trunk/solr/core/src/java/org/apache/solr/search/DisMaxQParserPlugin.java
lucene/dev/trunk/solr/core/src/java/org/apache/solr/servlet/DirectSolrConnection.java
lucene/dev/trunk/solr/core/src/java/org/apache/solr/util/plugin/MapInitializedPlugin.java
lucene/dev/trunk/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrServer.java
lucene/dev/trunk/solr/solrj/src/java/org/apache/solr/client/solrj/util/ClientUtils.java
lucene/dev/trunk/solr/test-framework/build.xml
Modified: lucene/dev/trunk/dev-tools/scripts/checkJavadocLinks.py
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/dev-tools/scripts/checkJavadocLinks.py?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/dev-tools/scripts/checkJavadocLinks.py (original)
+++ lucene/dev/trunk/dev-tools/scripts/checkJavadocLinks.py Mon Apr 23 13:44:03 2012
@@ -161,6 +161,15 @@ def checkAll(dirName):
elif link.find('lucene.apache.org/java/docs/discussion.html') != -1:
# OK
pass
+ elif link.find('lucene.apache.org/solr/mirrors-solr-latest-redir.html') != -1:
+ # OK
+ pass
+ elif link.find('lucene.apache.org/solr/discussion.html') != -1:
+ # OK
+ pass
+ elif link.find('lucene.apache.org/solr/features.html') != -1:
+ # OK
+ pass
elif link.find('svn.apache.org') != -1 or link.find('lucene.apache.org') != -1:
if not printed:
printed = True
Modified: lucene/dev/trunk/solr/common-build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/common-build.xml?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/common-build.xml (original)
+++ lucene/dev/trunk/solr/common-build.xml Mon Apr 23 13:44:03 2012
@@ -233,6 +233,7 @@
<link offline="true" href="${lucene.javadoc.url}/analyzers-phonetic" packagelistloc="${lucenedocs}/analyzers-phonetic"/>
<link offline="true" href="${lucene.javadoc.url}/analyzers-smartcn" packagelistloc="${lucenedocs}/analyzers-smartcn"/>
<link offline="true" href="${lucene.javadoc.url}/analyzers-stempel" packagelistloc="${lucenedocs}/analyzers-stempel"/>
+ <link offline="true" href="${lucene.javadoc.url}/analyzers-uima" packagelistloc="${lucenedocs}/analyzers-uima"/>
<link offline="true" href="${lucene.javadoc.url}/suggest" packagelistloc="${lucenedocs}/suggest"/>
<link offline="true" href="${lucene.javadoc.url}/grouping" packagelistloc="${lucenedocs}/grouping"/>
<link offline="true" href="${lucene.javadoc.url}/queries" packagelistloc="${lucenedocs}/queries"/>
Modified: lucene/dev/trunk/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DataSource.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DataSource.java?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DataSource.java (original)
+++ lucene/dev/trunk/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DataSource.java Mon Apr 23 13:44:03 2012
@@ -60,7 +60,7 @@ public abstract class DataSource<T> {
* for HttpDataSource or a file location for FileDataSource or a custom
* format for your own custom DataSource.
* @return Depends on the implementation. For instance JdbcDataSource returns
- * an Iterator<Map <String,Object>>
+ * an Iterator<Map <String,Object>>
*/
public abstract T getData(String query);
Modified: lucene/dev/trunk/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java (original)
+++ lucene/dev/trunk/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java Mon Apr 23 13:44:03 2012
@@ -43,7 +43,7 @@ import org.slf4j.LoggerFactory;
* /a//b...
* /a/b/c
* </pre>
- * A record is a Map<String,Object> . The key is the provided name
+ * A record is a Map<String,Object> . The key is the provided name
* and the value is a String or a List<String>
*
* This class is thread-safe for parsing xml. But adding fields is not
@@ -98,7 +98,7 @@ public class XPathRecordReader {
}
/**
- * A wrapper around {@link #addField0 addField0()} to create a series of
+ * A wrapper around <code>addField0</code> to create a series of
* Nodes based on the supplied Xpath and a given fieldName. The created
* nodes are inserted into a Node tree.
*
@@ -113,7 +113,7 @@ public class XPathRecordReader {
}
/**
- * A wrapper around {@link #addField0 addField0()} to create a series of
+ * A wrapper around <code>addField0</code> to create a series of
* Nodes based on the supplied Xpath and a given fieldName. The created
* nodes are inserted into a Node tree.
*
Modified: lucene/dev/trunk/solr/core/src/java/org/apache/solr/analysis/HTMLStripCharFilterFactory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/core/src/java/org/apache/solr/analysis/HTMLStripCharFilterFactory.java?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/core/src/java/org/apache/solr/analysis/HTMLStripCharFilterFactory.java (original)
+++ lucene/dev/trunk/solr/core/src/java/org/apache/solr/analysis/HTMLStripCharFilterFactory.java Mon Apr 23 13:44:03 2012
@@ -35,7 +35,7 @@ import java.util.regex.Pattern;
* <charFilter class="solr.HTMLStripCharFilterFactory" escapedTags="a, title" />
* <tokenizer class="solr.WhitespaceTokenizerFactory"/>
* </analyzer>
- * </fieldType></pre
+ * </fieldType></pre>
*
*/
public class HTMLStripCharFilterFactory extends BaseCharFilterFactory {
Modified: lucene/dev/trunk/solr/core/src/java/org/apache/solr/core/CoreContainer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/core/src/java/org/apache/solr/core/CoreContainer.java?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/core/src/java/org/apache/solr/core/CoreContainer.java (original)
+++ lucene/dev/trunk/solr/core/src/java/org/apache/solr/core/CoreContainer.java Mon Apr 23 13:44:03 2012
@@ -1006,7 +1006,6 @@ public class CoreContainer
}
/** Gets a core by name and increase its refcount.
- * @see SolrCore#open()
* @see SolrCore#close()
* @param name the core name
* @return the core if found
Modified: lucene/dev/trunk/solr/core/src/java/org/apache/solr/handler/component/SearchHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/core/src/java/org/apache/solr/handler/component/SearchHandler.java?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/core/src/java/org/apache/solr/handler/component/SearchHandler.java (original)
+++ lucene/dev/trunk/solr/core/src/java/org/apache/solr/handler/component/SearchHandler.java Mon Apr 23 13:44:03 2012
@@ -81,9 +81,9 @@ public class SearchHandler extends Reque
}
/**
- * Initialize the components based on name. Note, if using {@link #INIT_FIRST_COMPONENTS} or {@link #INIT_LAST_COMPONENTS},
+ * Initialize the components based on name. Note, if using <code>INIT_FIRST_COMPONENTS</code> or <code>INIT_LAST_COMPONENTS</code>,
* then the {@link DebugComponent} will always occur last. If this is not desired, then one must explicitly declare all components using
- * the {@link #INIT_COMPONENTS} syntax.
+ * the <code>INIT_COMPONENTS</code> syntax.
*/
@SuppressWarnings("unchecked")
public void inform(SolrCore core)
Modified: lucene/dev/trunk/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java (original)
+++ lucene/dev/trunk/solr/core/src/java/org/apache/solr/response/BinaryQueryResponseWriter.java Mon Apr 23 13:44:03 2012
@@ -25,7 +25,7 @@ import org.apache.solr.request.SolrQuery
/**
* Implementations of <code>BinaryQueryResponseWriter</code> are used to
* write response in binary format
- * Functionality is exactly same as its parent class <code>QueryResponseWriter</code
+ * 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/trunk/solr/core/src/java/org/apache/solr/search/DisMaxQParserPlugin.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/core/src/java/org/apache/solr/search/DisMaxQParserPlugin.java?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/core/src/java/org/apache/solr/search/DisMaxQParserPlugin.java (original)
+++ lucene/dev/trunk/solr/core/src/java/org/apache/solr/search/DisMaxQParserPlugin.java Mon Apr 23 13:44:03 2012
@@ -56,7 +56,7 @@ import org.apache.solr.request.SolrQuery
* </li>
* <li> mm - (Minimum Match) this supports a wide variety of
* complex expressions.
- * read {@link org.apache.solr.util.SolrPluginUtils#setMinShouldMatch SolrPluginUtils.setMinShouldMatch} and <a href="http://lucene.apache.org/solr/api/org/apache/solr/util/doc-files/min-should-match.html">mm expression format</a> for details.
+ * read {@link org.apache.solr.util.SolrPluginUtils#setMinShouldMatch SolrPluginUtils.setMinShouldMatch} and <a href="{@docRoot}/org/apache/solr/util/doc-files/min-should-match.html">mm expression format</a> for details.
* </li>
* <li> pf - (Phrase Fields) fields/boosts to make phrase queries out
* of, to boost the users query for exact matches on the specified fields.
Modified: lucene/dev/trunk/solr/core/src/java/org/apache/solr/servlet/DirectSolrConnection.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/core/src/java/org/apache/solr/servlet/DirectSolrConnection.java?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/core/src/java/org/apache/solr/servlet/DirectSolrConnection.java (original)
+++ lucene/dev/trunk/solr/core/src/java/org/apache/solr/servlet/DirectSolrConnection.java Mon Apr 23 13:44:03 2012
@@ -70,7 +70,7 @@ public class DirectSolrConnection
* For example:
*
* String json = solr.request( "/select?qt=dismax&wt=json&q=...", null );
- * String xml = solr.request( "/update", "<add><doc><field ..." );
+ * String xml = solr.request( "/update", "<add><doc><field ..." );
*/
public String request( String pathAndParams, String body ) throws Exception
{
Modified: lucene/dev/trunk/solr/core/src/java/org/apache/solr/util/plugin/MapInitializedPlugin.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/core/src/java/org/apache/solr/util/plugin/MapInitializedPlugin.java?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/core/src/java/org/apache/solr/util/plugin/MapInitializedPlugin.java (original)
+++ lucene/dev/trunk/solr/core/src/java/org/apache/solr/util/plugin/MapInitializedPlugin.java Mon Apr 23 13:44:03 2012
@@ -20,7 +20,7 @@ package org.apache.solr.util.plugin;
import java.util.Map;
/**
- * A plugin that can be initialized with a Map<String,String>
+ * A plugin that can be initialized with a Map<String,String>
*
*
* @since solr 1.3
Modified: lucene/dev/trunk/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrServer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrServer.java?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrServer.java (original)
+++ lucene/dev/trunk/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrServer.java Mon Apr 23 13:44:03 2012
@@ -126,17 +126,8 @@ public class HttpSolrServer extends Solr
private final HttpClient httpClient;
- /**
- * This defaults to false under the assumption that if you are following a
- * redirect to get to a Solr installation, something is misconfigured
- * somewhere.
- */
private boolean followRedirects = false;
- /**
- * Maximum number of retries to attempt in the event of transient errors.
- * Default: 0 (no) retries. No more than 1 recommended.
- */
private int maxRetries = 0;
private ThreadSafeClientConnManager ccm;
@@ -517,8 +508,11 @@ public class HttpSolrServer extends Solr
/**
* HttpClientParams.setRedirecting
- *
- * @see #followRedirects
+ * <p>
+ * This defaults to false under the assumption that if you are following a
+ * redirect to get to a Solr installation, something is misconfigured
+ * somewhere.
+ * </p>
*/
public void setFollowRedirects(boolean followRedirects) {
this.followRedirects = followRedirects;
@@ -613,10 +607,12 @@ public class HttpSolrServer extends Solr
/**
* Set maximum number of retries to attempt in the event of transient errors.
- *
+ * <p>
+ * Maximum number of retries to attempt in the event of transient errors.
+ * Default: 0 (no) retries. No more than 1 recommended.
+ * </p>
* @param maxRetries
* No more than 1 recommended
- * @see #maxRetries
*/
public void setMaxRetries(int maxRetries) {
if (maxRetries > 1) {
Modified: lucene/dev/trunk/solr/solrj/src/java/org/apache/solr/client/solrj/util/ClientUtils.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/solrj/src/java/org/apache/solr/client/solrj/util/ClientUtils.java?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/solrj/src/java/org/apache/solr/client/solrj/util/ClientUtils.java (original)
+++ lucene/dev/trunk/solr/solrj/src/java/org/apache/solr/client/solrj/util/ClientUtils.java Mon Apr 23 13:44:03 2012
@@ -180,7 +180,8 @@ public class ClientUtils
/**
- * See: <a href="http://lucene.apache.org/java/docs/nightly/queryparsersyntax.html#Escaping%20Special%20Characters">Escaping Special Characters</a>
+ * See: {@link org.apache.lucene.queryparser.classic queryparser syntax}
+ * for more information on Escaping Special Characters
*/
public static String escapeQueryChars(String s) {
StringBuilder sb = new StringBuilder();
Modified: lucene/dev/trunk/solr/test-framework/build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/test-framework/build.xml?rev=1329235&r1=1329234&r2=1329235&view=diff
==============================================================================
--- lucene/dev/trunk/solr/test-framework/build.xml (original)
+++ lucene/dev/trunk/solr/test-framework/build.xml Mon Apr 23 13:44:03 2012
@@ -44,14 +44,15 @@
<target name="javadocs"
depends="compile-core,lucene-javadocs,javadocs-test-framework,define-lucene-javadoc-url">
<sequential>
- <solr-invoke-javadoc>
- <solrsources>
+ <mkdir dir="${javadoc.dir}"/>
+ <invoke-javadoc destdir="${javadoc.dir}"
+ title="${Name}" overview="${src.dir}/overview.html">
+ <sources>
<link offline="true" href="${javadoc.link.junit}"
packagelistLoc="${javadoc.packagelist.dir}/junit"/>
- <link offline="true" href="${lucene.javadoc.url}/test-framework" packagelistloc="${lucenedocs}/test-framework"/>
<packageset dir="${src.dir}"/>
- </solrsources>
- </solr-invoke-javadoc>
+ </sources>
+ </invoke-javadoc>
<solr-jarify basedir="${javadoc.dir}" destfile="${build.dir}/${final.name}-javadoc.jar"/>
<mkdir dir="${dest}/docs/api/test-framework"/>
<copy todir="${dest}/docs/api/test-framework">