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 2010/10/03 22:14:53 UTC
svn commit: r1004038 - in /lucene/dev/trunk/solr: ./
contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/
src/java/org/apache/solr/analysis/ src/java/org/apache/solr/highlight/
src/java/org/apache/solr/response/ src/java/org/apac...
Author: rmuir
Date: Sun Oct 3 20:14:52 2010
New Revision: 1004038
URL: http://svn.apache.org/viewvc?rev=1004038&view=rev
Log:
clear up javadocs warnings
Modified:
lucene/dev/trunk/solr/common-build.xml
lucene/dev/trunk/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/HTMLStripTransformer.java
lucene/dev/trunk/solr/src/java/org/apache/solr/analysis/BaseTokenStreamFactory.java
lucene/dev/trunk/solr/src/java/org/apache/solr/analysis/BufferedTokenStream.java
lucene/dev/trunk/solr/src/java/org/apache/solr/highlight/SolrFragmentsBuilder.java
lucene/dev/trunk/solr/src/java/org/apache/solr/response/GenericBinaryResponseWriter.java
lucene/dev/trunk/solr/src/java/org/apache/solr/response/GenericTextResponseWriter.java
lucene/dev/trunk/solr/src/java/org/apache/solr/response/XMLWriter.java
lucene/dev/trunk/solr/src/java/org/apache/solr/search/SpatialFilterQParser.java
lucene/dev/trunk/solr/src/java/org/apache/solr/search/function/DocFreqValueSource.java
lucene/dev/trunk/solr/src/java/org/apache/solr/search/function/IDFValueSource.java
lucene/dev/trunk/solr/src/java/org/apache/solr/spelling/suggest/tst/TernaryTreeNode.java
Modified: lucene/dev/trunk/solr/common-build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/common-build.xml?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/common-build.xml (original)
+++ lucene/dev/trunk/solr/common-build.xml Sun Oct 3 20:14:52 2010
@@ -346,6 +346,10 @@
bottom="Copyright © ${year} Apache Software Foundation. All Rights Reserved.">
<tag name="todo" description="To Do:"/>
<tag name="uml.property" description="UML Property:"/>
+ <tag name="lucene.experimental"
+ description="WARNING: This API is experimental and might change in incompatible ways in the next release."/>
+ <tag name="lucene.internal"
+ description="NOTE: This API is for Lucene internal purposes only and might change in incompatible ways in the next release."/>
<link offline="true" packagelistLoc="${build.javadoc}"/>
<link href="${javadoc.link.java}"/>
<link href="${javadoc.link.junit}"/>
Modified: lucene/dev/trunk/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/HTMLStripTransformer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/HTMLStripTransformer.java?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/HTMLStripTransformer.java (original)
+++ lucene/dev/trunk/solr/contrib/dataimporthandler/src/main/java/org/apache/solr/handler/dataimport/HTMLStripTransformer.java Sun Oct 3 20:14:52 2010
@@ -31,7 +31,7 @@ import java.util.Map;
* in case you don't need this HTML anyway.
*
* @version $Id$
- * @see org.apache.solr.analysis.HTMLStripCharFilter
+ * @see HTMLStripCharFilter
* @since solr 1.4
*/
public class HTMLStripTransformer extends Transformer {
Modified: lucene/dev/trunk/solr/src/java/org/apache/solr/analysis/BaseTokenStreamFactory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/src/java/org/apache/solr/analysis/BaseTokenStreamFactory.java?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/src/java/org/apache/solr/analysis/BaseTokenStreamFactory.java (original)
+++ lucene/dev/trunk/solr/src/java/org/apache/solr/analysis/BaseTokenStreamFactory.java Sun Oct 3 20:14:52 2010
@@ -57,7 +57,8 @@ abstract class BaseTokenStreamFactory {
return args;
}
- /** this method can be called in the {@link #create} method,
+ /** this method can be called in the {@link TokenizerFactory#create(java.io.Reader)}
+ * or {@link TokenFilterFactory#create(org.apache.lucene.analysis.TokenStream)} methods,
* to inform user, that for this factory a {@link #luceneMatchVersion} is required */
protected final void assureMatchVersion() {
if (luceneMatchVersion == null) {
Modified: lucene/dev/trunk/solr/src/java/org/apache/solr/analysis/BufferedTokenStream.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/src/java/org/apache/solr/analysis/BufferedTokenStream.java?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/src/java/org/apache/solr/analysis/BufferedTokenStream.java (original)
+++ lucene/dev/trunk/solr/src/java/org/apache/solr/analysis/BufferedTokenStream.java Sun Oct 3 20:14:52 2010
@@ -64,7 +64,7 @@ import java.util.LinkedList;
* example above, the subclass must clone the additional "A" it creates.
*
* @deprecated This class does not support custom attributes. Extend TokenFilter instead,
- * using {@link AttributeSource#captureState()} and {@link AttributeSource#restoreState()}
+ * using {@link AttributeSource#captureState()} and {@link AttributeSource#restoreState(State)}
* which support all attributes.
*/
@Deprecated
Modified: lucene/dev/trunk/solr/src/java/org/apache/solr/highlight/SolrFragmentsBuilder.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/src/java/org/apache/solr/highlight/SolrFragmentsBuilder.java?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/src/java/org/apache/solr/highlight/SolrFragmentsBuilder.java (original)
+++ lucene/dev/trunk/solr/src/java/org/apache/solr/highlight/SolrFragmentsBuilder.java Sun Oct 3 20:14:52 2010
@@ -34,7 +34,6 @@ public abstract class SolrFragmentsBuild
/**
* Return a {@link org.apache.lucene.search.vectorhighlight.FragmentsBuilder} appropriate for this field.
*
- * @param fieldName The name of the field
* @param params The params controlling Highlighting
* @return An appropriate {@link org.apache.lucene.search.vectorhighlight.FragmentsBuilder}.
*/
Modified: lucene/dev/trunk/solr/src/java/org/apache/solr/response/GenericBinaryResponseWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/src/java/org/apache/solr/response/GenericBinaryResponseWriter.java?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/src/java/org/apache/solr/response/GenericBinaryResponseWriter.java (original)
+++ lucene/dev/trunk/solr/src/java/org/apache/solr/response/GenericBinaryResponseWriter.java Sun Oct 3 20:14:52 2010
@@ -25,6 +25,8 @@ import org.apache.solr.common.SolrDocume
import org.apache.solr.common.SolrInputDocument;
import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.response.BaseResponseWriter.SingleResponseWriter; // javadocs
+
/**
*
*
Modified: lucene/dev/trunk/solr/src/java/org/apache/solr/response/GenericTextResponseWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/src/java/org/apache/solr/response/GenericTextResponseWriter.java?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/src/java/org/apache/solr/response/GenericTextResponseWriter.java (original)
+++ lucene/dev/trunk/solr/src/java/org/apache/solr/response/GenericTextResponseWriter.java Sun Oct 3 20:14:52 2010
@@ -24,6 +24,8 @@ import org.apache.solr.common.SolrDocume
import org.apache.solr.common.SolrInputDocument;
import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.response.BaseResponseWriter.SingleResponseWriter; // javadocs
+
/**
*
*
@@ -46,7 +48,7 @@ public abstract class GenericTextRespons
* {@link #getSingleResponseWriter(Writer, SolrQueryRequest, SolrQueryResponse)}
* .
*
- * @param out
+ * @param writer
* The {@link Writer} to write the text output to.
* @param request
* The provided {@link SolrQueryRequest}.
Modified: lucene/dev/trunk/solr/src/java/org/apache/solr/response/XMLWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/src/java/org/apache/solr/response/XMLWriter.java?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/src/java/org/apache/solr/response/XMLWriter.java (original)
+++ lucene/dev/trunk/solr/src/java/org/apache/solr/response/XMLWriter.java Sun Oct 3 20:14:52 2010
@@ -635,7 +635,7 @@ final public class XMLWriter {
* @param name
* @param map
* @throws IOException
- * @see http://lucene.apache.org/solr/api/org/apache/solr/response/SolrQueryResponse.html#returnable_data
+ * @see SolrQueryResponse Note on Returnable Data
*/
public void writeMap(String name, Map<Object,Object> map) throws IOException {
int sz = map.size();
Modified: lucene/dev/trunk/solr/src/java/org/apache/solr/search/SpatialFilterQParser.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/src/java/org/apache/solr/search/SpatialFilterQParser.java?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/src/java/org/apache/solr/search/SpatialFilterQParser.java (original)
+++ lucene/dev/trunk/solr/src/java/org/apache/solr/search/SpatialFilterQParser.java Sun Oct 3 20:14:52 2010
@@ -33,7 +33,7 @@ import org.apache.solr.schema.SpatialQue
/**
- * @see {@link SpatialFilterQParserPlugin}
+ * @see SpatialFilterQParserPlugin
*/
public class SpatialFilterQParser extends QParser {
boolean bbox; // do bounding box only
Modified: lucene/dev/trunk/solr/src/java/org/apache/solr/search/function/DocFreqValueSource.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/src/java/org/apache/solr/search/function/DocFreqValueSource.java?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/src/java/org/apache/solr/search/function/DocFreqValueSource.java (original)
+++ lucene/dev/trunk/solr/src/java/org/apache/solr/search/function/DocFreqValueSource.java Sun Oct 3 20:14:52 2010
@@ -215,7 +215,7 @@ abstract class IntDocValues extends DocV
/**
* <code>DocFreqValueSource</code> returns the number of documents containing the term.
- * @internal
+ * @lucene.internal
*/
public class DocFreqValueSource extends ValueSource {
protected String field;
Modified: lucene/dev/trunk/solr/src/java/org/apache/solr/search/function/IDFValueSource.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/src/java/org/apache/solr/search/function/IDFValueSource.java?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/src/java/org/apache/solr/search/function/IDFValueSource.java (original)
+++ lucene/dev/trunk/solr/src/java/org/apache/solr/search/function/IDFValueSource.java Sun Oct 3 20:14:52 2010
@@ -29,7 +29,7 @@ import org.apache.solr.util.ByteUtils;
import java.io.IOException;
import java.util.Map;
-/** @internal */
+/** @lucene.internal */
public class IDFValueSource extends DocFreqValueSource {
public IDFValueSource(String field, String val, String indexedField, BytesRef indexedBytes) {
super(field, val, indexedField, indexedBytes);
Modified: lucene/dev/trunk/solr/src/java/org/apache/solr/spelling/suggest/tst/TernaryTreeNode.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/solr/src/java/org/apache/solr/spelling/suggest/tst/TernaryTreeNode.java?rev=1004038&r1=1004037&r2=1004038&view=diff
==============================================================================
--- lucene/dev/trunk/solr/src/java/org/apache/solr/spelling/suggest/tst/TernaryTreeNode.java (original)
+++ lucene/dev/trunk/solr/src/java/org/apache/solr/spelling/suggest/tst/TernaryTreeNode.java Sun Oct 3 20:14:52 2010
@@ -2,20 +2,24 @@ package org.apache.solr.spelling.suggest
/**
* The class creates a TST node.
- * @variable splitchar the character stored by a node.
- * @variable loKid a reference object to the node containing character smaller than
- * this node's character.
- * @variable eqKid a reference object to the node containg character next to this
- * node's character as occuring in the inserted token.
- * @variable hiKid a reference object to the node containing character higher than
- * this node's character.
- * @variable token used by leaf nodes to store the complete tokens to be added to
- * suggest list while auto-completing the prefix.
*/
public class TernaryTreeNode {
+ /** the character stored by a node. */
char splitchar;
- TernaryTreeNode loKid, eqKid, hiKid;
+ /** a reference object to the node containing character smaller than this node's character. */
+ TernaryTreeNode loKid;
+ /**
+ * a reference object to the node containing character next to this node's character as
+ * occurring in the inserted token.
+ */
+ TernaryTreeNode eqKid;
+ /** a reference object to the node containing character higher than this node's character. */
+ TernaryTreeNode hiKid;
+ /**
+ * used by leaf nodes to store the complete tokens to be added to suggest list while
+ * auto-completing the prefix.
+ */
String token;
Object val;
}