You are viewing a plain text version of this content. The canonical link for it is here.
Posted to solr-commits@lucene.apache.org by ho...@apache.org on 2006/05/27 03:35:44 UTC
svn commit: r409791 - in /incubator/solr/trunk: ./
src/java/org/apache/solr/core/ src/java/org/apache/solr/search/
src/java/org/apache/solr/search/function/ src/java/org/apache/solr/util/
Author: hossman
Date: Fri May 26 18:35:44 2006
New Revision: 409791
URL: http://svn.apache.org/viewvc?rev=409791&view=rev
Log:
minor cleanup of existing javadocs to reduce warnings
Modified:
incubator/solr/trunk/build.xml
incubator/solr/trunk/src/java/org/apache/solr/core/Config.java
incubator/solr/trunk/src/java/org/apache/solr/core/SolrCore.java
incubator/solr/trunk/src/java/org/apache/solr/search/QueryParsing.java
incubator/solr/trunk/src/java/org/apache/solr/search/SolrIndexSearcher.java
incubator/solr/trunk/src/java/org/apache/solr/search/function/DocValues.java
incubator/solr/trunk/src/java/org/apache/solr/util/TestHarness.java
Modified: incubator/solr/trunk/build.xml
URL: http://svn.apache.org/viewvc/incubator/solr/trunk/build.xml?rev=409791&r1=409790&r2=409791&view=diff
==============================================================================
--- incubator/solr/trunk/build.xml (original)
+++ incubator/solr/trunk/build.xml Fri May 26 18:35:44 2006
@@ -26,6 +26,10 @@
<property name="build.docs" value="${dest}/docs"/>
<property name="javadoc.link.java"
value="http://java.sun.com/j2se/1.5.0/docs/api/"/>
+ <property name="javadoc.link.junit"
+ value="http://junit.sourceforge.net/javadoc/"/>
+ <property name="javadoc.link.lucene"
+ value="http://lucene.apache.org/java/docs/api/"/>
<property name="javadoc.packages" value="org.apache.solr.*"/>
<property name="build.javadoc" value="${build.docs}/api"/>
@@ -96,6 +100,8 @@
<packageset dir="${src}/java"/>
<packageset dir="${src}/webapp/src"/>
<link href="${javadoc.link.java}"/>
+ <link href="${javadoc.link.junit}"/>
+ <link href="${javadoc.link.lucene}"/>
<classpath refid="compile.classpath"/>
</javadoc>
</target>
Modified: incubator/solr/trunk/src/java/org/apache/solr/core/Config.java
URL: http://svn.apache.org/viewvc/incubator/solr/trunk/src/java/org/apache/solr/core/Config.java?rev=409791&r1=409790&r2=409791&view=diff
==============================================================================
--- incubator/solr/trunk/src/java/org/apache/solr/core/Config.java (original)
+++ incubator/solr/trunk/src/java/org/apache/solr/core/Config.java Fri May 26 18:35:44 2006
@@ -279,9 +279,16 @@
}
/**
- * Returns a list of non-blank non-comment lines with whitespace trimmed from front and back.
+ * Accesses a resource by name and returns the (non comment) lines
+ * containing data.
+ *
+ * <p>
+ * A comment line is any line that starts with the character "#"
+ * </p>
+ *
* @param resource
- * @return
+ * @return a list of non-blank non-comment lines with whitespace trimmed
+ * from front and back.
* @throws IOException
*/
public static List<String> getLines(String resource) throws IOException {
Modified: incubator/solr/trunk/src/java/org/apache/solr/core/SolrCore.java
URL: http://svn.apache.org/viewvc/incubator/solr/trunk/src/java/org/apache/solr/core/SolrCore.java?rev=409791&r1=409790&r2=409791&view=diff
==============================================================================
--- incubator/solr/trunk/src/java/org/apache/solr/core/SolrCore.java (original)
+++ incubator/solr/trunk/src/java/org/apache/solr/core/SolrCore.java Fri May 26 18:35:44 2006
@@ -289,7 +289,7 @@
* searcher will be created.</li>
* </ul>
* <p>
- * If <tt>returnSearcher==true</tt> then a {@link RefCounted}<{@link SolrIndexSearcher}> will be returned with
+ * If <tt>returnSearcher==true</tt> then a {@link RefCounted}<{@link SolrIndexSearcher}> will be returned with
* the reference count incremented. It <b>must</b> be decremented when no longer needed.
* <p>
* If <tt>waitSearcher!=null</tt> and a new {@link SolrIndexSearcher} was created,
@@ -298,9 +298,8 @@
* this method returned.
* <p>
* @param forceNew if true, force the open of a new index searcher regardless if there is already one open.
- * @param returnSearcher if true, returns a {@link <SolrIndexSearcher>} holder with the refcount already incremented.
+ * @param returnSearcher if true, returns a {@link SolrIndexSearcher} holder with the refcount already incremented.
* @param waitSearcher if non-null, will be filled in with a {@link Future} that will return after the new searcher is registered.
- * @return
* @throws IOException
*/
public RefCounted<SolrIndexSearcher> getSearcher(boolean forceNew, boolean returnSearcher, final Future[] waitSearcher) throws IOException {
Modified: incubator/solr/trunk/src/java/org/apache/solr/search/QueryParsing.java
URL: http://svn.apache.org/viewvc/incubator/solr/trunk/src/java/org/apache/solr/search/QueryParsing.java?rev=409791&r1=409790&r2=409791&view=diff
==============================================================================
--- incubator/solr/trunk/src/java/org/apache/solr/search/QueryParsing.java (original)
+++ incubator/solr/trunk/src/java/org/apache/solr/search/QueryParsing.java Fri May 26 18:35:44 2006
@@ -81,8 +81,8 @@
/**
* Gets the number of documens to return after sorting.
- * -1 means there is no cutoff (only do the sort)
- * @return
+ *
+ * @return number of docs to return, or -1 for no cut off (just sort)
*/
public int getCount() { return num; }
}
Modified: incubator/solr/trunk/src/java/org/apache/solr/search/SolrIndexSearcher.java
URL: http://svn.apache.org/viewvc/incubator/solr/trunk/src/java/org/apache/solr/search/SolrIndexSearcher.java?rev=409791&r1=409790&r2=409791&view=diff
==============================================================================
--- incubator/solr/trunk/src/java/org/apache/solr/search/SolrIndexSearcher.java (original)
+++ incubator/solr/trunk/src/java/org/apache/solr/search/SolrIndexSearcher.java Fri May 26 18:35:44 2006
@@ -470,10 +470,10 @@
* This method is cache-aware and attempts to retrieve the answer from the cache if possible.
* If the answer was not cached, it may have been inserted into the cache as a result of this call.
* <p>
- * The DocSet returned should <b>not</b> be modified.
*
* @param query
* @param filter may be null
+ * @return DocSet meeting the specified criteria, should <b>not</b> be modified by the caller.
*/
public DocSet getDocSet(Query query, DocSet filter) throws IOException {
if (filter==null) return getDocSet(query);
@@ -533,14 +533,12 @@
* <p>
* FUTURE: The returned DocList may be retrieved from a cache.
*
- * The DocList returned should <b>not</b> be modified.
- *
* @param query
* @param filter may be null
* @param lsort criteria by which to sort (if null, query relevance is used)
* @param offset offset into the list of documents to return
* @param len maximum number of documents to return
- * @return
+ * @return DocList meeting the specified criteria, should <b>not</b> be modified by the caller.
* @throws IOException
*/
public DocList getDocList(Query query, Query filter, Sort lsort, int offset, int len) throws IOException {
@@ -955,15 +953,13 @@
* Returns documents matching both <code>query</code> and <code>filter</code>
* and sorted by <code>sort</code>.
* FUTURE: The returned DocList may be retrieved from a cache.
- * <p>
- * The DocList returned should <b>not</b> be modified.
*
* @param query
* @param filter may be null
* @param lsort criteria by which to sort (if null, query relevance is used)
* @param offset offset into the list of documents to return
* @param len maximum number of documents to return
- * @return
+ * @return DocList meeting the specified criteria, should <b>not</b> be modified by the caller.
* @throws IOException
*/
public DocList getDocList(Query query, DocSet filter, Sort lsort, int offset, int len) throws IOException {
@@ -989,7 +985,7 @@
* @param lsort criteria by which to sort (if null, query relevance is used)
* @param offset offset into the list of documents to return
* @param len maximum number of documents to return
- * @return
+ * @return DocListAndSet meeting the specified criteria, should <b>not</b> be modified by the caller.
* @throws IOException
*/
public DocListAndSet getDocListAndSet(Query query, Query filter, Sort lsort, int offset, int len) throws IOException {
@@ -1017,15 +1013,13 @@
* matching <code>query</code> and <code>filter</code> (regardless of <code>offset</code> and <code>len</code>).
* <p>
* FUTURE: The returned DocList may be retrieved from a cache.
- * <p>
- * The DocList and DocSet returned should <b>not</b> be modified.
*
* @param query
* @param filter may be null
* @param lsort criteria by which to sort (if null, query relevance is used)
* @param offset offset into the list of documents to return
* @param len maximum number of documents to return
- * @return
+ * @return DocListAndSet meeting the specified criteria, should <b>not</b> be modified by the caller.
* @throws IOException
*/
public DocListAndSet getDocListAndSet(Query query, DocSet filter, Sort lsort, int offset, int len) throws IOException {
Modified: incubator/solr/trunk/src/java/org/apache/solr/search/function/DocValues.java
URL: http://svn.apache.org/viewvc/incubator/solr/trunk/src/java/org/apache/solr/search/function/DocValues.java?rev=409791&r1=409790&r2=409791&view=diff
==============================================================================
--- incubator/solr/trunk/src/java/org/apache/solr/search/function/DocValues.java (original)
+++ incubator/solr/trunk/src/java/org/apache/solr/search/function/DocValues.java Fri May 26 18:35:44 2006
@@ -21,8 +21,6 @@
/**
* Represents field values as different types.
* Normally created via a {@link ValueSource} for a particular field and reader.
- * <br>
- * Often used by {@link FunctionFactory} implementations.
*
* @author yonik
* @version $Id$
Modified: incubator/solr/trunk/src/java/org/apache/solr/util/TestHarness.java
URL: http://svn.apache.org/viewvc/incubator/solr/trunk/src/java/org/apache/solr/util/TestHarness.java?rev=409791&r1=409790&r2=409791&view=diff
==============================================================================
--- incubator/solr/trunk/src/java/org/apache/solr/util/TestHarness.java (original)
+++ incubator/solr/trunk/src/java/org/apache/solr/util/TestHarness.java Fri May 26 18:35:44 2006
@@ -132,7 +132,7 @@
*
* @param fieldsAndValues Odds are field names, Evens are values
* @return null if succesful, otherwise the XML response to the update
- * @see appendSimpleDoc
+ * @see #appendSimpleDoc
*/
public String validateAddDoc(String... fieldsAndValues)
throws XPathExpressionException, SAXException, IOException {