You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-commits@lucene.apache.org by ho...@apache.org on 2009/08/27 17:34:26 UTC
svn commit: r808459 - in /lucene/java/trunk:
contrib/analyzers/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/
contrib/highlighter/src/java/org/apache/lucene/search/highlight/
contrib/queryparser/src/java/org/apache/lucene/messages/ contrib/...
Author: hossman
Date: Thu Aug 27 15:34:23 2009
New Revision: 808459
URL: http://svn.apache.org/viewvc?rev=808459&view=rev
Log:
fix numerous javadoc errors, many of which only show up at the private level
Modified:
lucene/java/trunk/contrib/analyzers/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/HHMMSegmenter.java
lucene/java/trunk/contrib/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java
lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/messages/NLS.java
lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/parser/EscapeQuerySyntaxImpl.java
lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/processors/GroupQueryNodeProcessor.java
lucene/java/trunk/src/java/org/apache/lucene/index/CheckIndex.java
lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java
lucene/java/trunk/src/java/org/apache/lucene/index/RawPostingList.java
lucene/java/trunk/src/java/org/apache/lucene/search/BooleanScorer.java
lucene/java/trunk/src/java/org/apache/lucene/search/BooleanScorer2.java
lucene/java/trunk/src/java/org/apache/lucene/search/DisjunctionSumScorer.java
lucene/java/trunk/src/java/org/apache/lucene/search/TermScorer.java
Modified: lucene/java/trunk/contrib/analyzers/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/HHMMSegmenter.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/contrib/analyzers/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/HHMMSegmenter.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/contrib/analyzers/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/HHMMSegmenter.java (original)
+++ lucene/java/trunk/contrib/analyzers/smartcn/src/java/org/apache/lucene/analysis/cn/smart/hhmm/HHMMSegmenter.java Thu Aug 27 15:34:23 2009
@@ -176,7 +176,7 @@
/**
* Get the character types for every character in a sentence.
*
- * @see Utility#charType(char)
+ * @see Utility#getCharType(char)
* @param sentence input sentence
* @return array of character types corresponding to character positions in the sentence
*/
Modified: lucene/java/trunk/contrib/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/contrib/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/contrib/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java (original)
+++ lucene/java/trunk/contrib/highlighter/src/java/org/apache/lucene/search/highlight/QueryScorer.java Thu Aug 27 15:34:23 2009
@@ -179,10 +179,6 @@
}
/**
- * @param query
- * @param field
- * @param tokenStream
- * @param reader
*/
private void init(Query query, String field, IndexReader reader, boolean expandMultiTermQuery) {
this.reader = reader;
Modified: lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/messages/NLS.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/messages/NLS.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/messages/NLS.java (original)
+++ lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/messages/NLS.java Thu Aug 27 15:34:23 2009
@@ -124,7 +124,6 @@
}
/**
- * @param bundleName
* @param clazz
*/
private static void load(Class<Object> clazz) {
Modified: lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/parser/EscapeQuerySyntaxImpl.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/parser/EscapeQuerySyntaxImpl.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/parser/EscapeQuerySyntaxImpl.java (original)
+++ lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/parser/EscapeQuerySyntaxImpl.java Thu Aug 27 15:34:23 2009
@@ -98,7 +98,7 @@
/**
* replace with ignore case
*
- * @param stringOrig
+ * @param string
* string to get replaced
* @param sequence1
* the old character sequence in lowercase
@@ -164,7 +164,7 @@
/**
* escape all tokens that are part of the parser syntax on a given string
*
- * @param string
+ * @param str
* string to get replaced
* @param locale
* locale to be used when performing string compares
Modified: lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/processors/GroupQueryNodeProcessor.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/processors/GroupQueryNodeProcessor.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/processors/GroupQueryNodeProcessor.java (original)
+++ lucene/java/trunk/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/processors/GroupQueryNodeProcessor.java Thu Aug 27 15:34:23 2009
@@ -106,8 +106,6 @@
}
/**
- * @param node
- * @return
*/
private QueryNode applyModifier(QueryNode node, QueryNode parent) {
Modified: lucene/java/trunk/src/java/org/apache/lucene/index/CheckIndex.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/CheckIndex.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/CheckIndex.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/CheckIndex.java Thu Aug 27 15:34:23 2009
@@ -99,9 +99,11 @@
/** Directory index is in. */
public Directory dir;
- /** SegmentInfos instance containing only segments that
- * had no problems (this is used with the {@link
- * CheckIndex#fix} method to repair the index. */
+ /**
+ * SegmentInfos instance containing only segments that
+ * had no problems (this is used with the {@link CheckIndex#fixIndex}
+ * method to repair the index.
+ */
SegmentInfos newSegments;
/** How many documents will be lost to bad segments. */
Modified: lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/IndexWriter.java Thu Aug 27 15:34:23 2009
@@ -649,7 +649,6 @@
* @see #release(SegmentReader)
* @param info
* @param doOpenStores
- * @return
* @throws IOException
*/
public synchronized SegmentReader get(SegmentInfo info, boolean doOpenStores) throws IOException {
@@ -664,7 +663,6 @@
* @param doOpenStores
* @param readBufferSize
* @param termsIndexDivisor
- * @return
* @throws IOException
*/
public synchronized SegmentReader get(SegmentInfo info, boolean doOpenStores, int readBufferSize, int termsIndexDivisor) throws IOException {
Modified: lucene/java/trunk/src/java/org/apache/lucene/index/RawPostingList.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/RawPostingList.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/RawPostingList.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/RawPostingList.java Thu Aug 27 15:34:23 2009
@@ -21,11 +21,11 @@
/** This is the base class for an in-memory posting list,
* keyed by a Token. {@link TermsHash} maintains a hash
* table holding one instance of this per unique Token.
- * Consumers of TermsHash (@link TermsHashConsumer} must
+ * Consumers of TermsHash ({@link TermsHashConsumer}) must
* subclass this class with its own concrete class.
- * {@link FreqProxTermsWriter.RawPostingList} is the
- * subclass used for the freq/prox postings, and {@link
- * TermVectorsTermsWriter.PostingList} is the subclass
+ * FreqProxTermsWriter.PostingList is a private inner class used
+ * for the freq/prox postings, and
+ * TermVectorsTermsWriter.PostingList is a private inner class
* used to hold TermVectors postings. */
abstract class RawPostingList {
Modified: lucene/java/trunk/src/java/org/apache/lucene/search/BooleanScorer.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/BooleanScorer.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/BooleanScorer.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/BooleanScorer.java Thu Aug 27 15:34:23 2009
@@ -280,7 +280,7 @@
return false;
}
- /** @deprecated use {@link #score(Collector, int)} instead. */
+ /** @deprecated use {@link #score(Collector, int, int)} instead. */
protected boolean score(HitCollector hc, int max) throws IOException {
return score(new HitCollectorWrapper(hc), max, docID());
}
Modified: lucene/java/trunk/src/java/org/apache/lucene/search/BooleanScorer2.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/BooleanScorer2.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/BooleanScorer2.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/BooleanScorer2.java Thu Aug 27 15:34:23 2009
@@ -300,7 +300,7 @@
* {@link HitCollector#collect(int, float)}.
* @param max Do not score documents past this.
* @return true if more matching documents may remain.
- * @deprecated use {@link #score(Collector, int)} instead.
+ * @deprecated use {@link #score(Collector, int, int)} instead.
*/
protected boolean score(HitCollector hc, int max) throws IOException {
return score(new HitCollectorWrapper(hc), max, docID());
Modified: lucene/java/trunk/src/java/org/apache/lucene/search/DisjunctionSumScorer.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/DisjunctionSumScorer.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/DisjunctionSumScorer.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/DisjunctionSumScorer.java Thu Aug 27 15:34:23 2009
@@ -136,7 +136,7 @@
* {@link HitCollector#collect(int, float)}.
* @param max Do not score documents past this.
* @return true if more matching documents may remain.
- * @deprecated use {@link #score(Collector, int)} instead.
+ * @deprecated use {@link #score(Collector, int, int)} instead.
*/
protected boolean score(HitCollector hc, int max) throws IOException {
return score(new HitCollectorWrapper(hc), max, docID());
Modified: lucene/java/trunk/src/java/org/apache/lucene/search/TermScorer.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/TermScorer.java?rev=808459&r1=808458&r2=808459&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/TermScorer.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/TermScorer.java Thu Aug 27 15:34:23 2009
@@ -74,7 +74,7 @@
score(c, Integer.MAX_VALUE, nextDoc());
}
- /** @deprecated use {@link #score(Collector, int)} instead. */
+ /** @deprecated use {@link #score(Collector, int, int)} instead. */
protected boolean score(HitCollector c, int end) throws IOException {
return score(new HitCollectorWrapper(c), end, doc);
}