Revision: 14989
http://gate.svn.sourceforge.net/gate/?rev=14989&view=rev
Author: markagreenwood
Date: 2012-01-10 17:51:05 +0000 (Tue, 10 Jan 2012)
Log Message:
-----------
lots more javadoc fixes
Modified Paths:
--------------
gate/trunk/src/gate/creole/annic/apache/lucene/analysis/TokenStream.java
gate/trunk/src/gate/creole/annic/apache/lucene/search/IndexSearcher.java
gate/trunk/src/gate/creole/annic/apache/lucene/search/Query.java
gate/trunk/src/gate/creole/annic/apache/lucene/search/Scorer.java
gate/trunk/src/gate/creole/annic/apache/lucene/search/Weight.java
gate/trunk/src/gate/html/NekoHtmlDocumentHandler.java
gate/trunk/src/gate/security/SessionImpl.java
gate/trunk/src/gate/util/ant/packager/GazetteerLists.java
gate/trunk/src/gate/util/persistence/UnconditionalRunningStrategyPersistence.java
Modified:
gate/trunk/src/gate/creole/annic/apache/lucene/analysis/TokenStream.java
===================================================================
--- gate/trunk/src/gate/creole/annic/apache/lucene/analysis/TokenStream.java
2012-01-10 17:03:21 UTC (rev 14988)
+++ gate/trunk/src/gate/creole/annic/apache/lucene/analysis/TokenStream.java
2012-01-10 17:51:05 UTC (rev 14989)
@@ -18,18 +18,10 @@
import java.io.IOException;
-/** A TokenStream enumerates the sequence of tokens, either from
- fields of a document or from query text.
- <p>
- This is an abstract class. Concrete subclasses are:
- <ul>
- <li>{@link Tokenizer}, a TokenStream
- whose input is a Reader; and
- <li>{@link TokenFilter}, a TokenStream
- whose input is another TokenStream.
- </ul>
- */
-
+/**
+ * A TokenStream enumerates the sequence of tokens, either from fields of a
+ * document or from query text.
+ */
public abstract class TokenStream {
/** Returns the next token in the stream, or null at EOS. */
public abstract Token next() throws IOException;
Modified:
gate/trunk/src/gate/creole/annic/apache/lucene/search/IndexSearcher.java
===================================================================
--- gate/trunk/src/gate/creole/annic/apache/lucene/search/IndexSearcher.java
2012-01-10 17:03:21 UTC (rev 14988)
+++ gate/trunk/src/gate/creole/annic/apache/lucene/search/IndexSearcher.java
2012-01-10 17:51:05 UTC (rev 14989)
@@ -241,8 +241,6 @@
* document numbers, second list contains first term positions, third
* list contains the pattern lengths and the fourth one contains the
* query type for each pattern.
- *
- * @return
*/
public ArrayList[] getFirstTermPositions() {
return new ArrayList[] {documentNumbers, firstTermPositions,
Modified: gate/trunk/src/gate/creole/annic/apache/lucene/search/Query.java
===================================================================
--- gate/trunk/src/gate/creole/annic/apache/lucene/search/Query.java
2012-01-10 17:03:21 UTC (rev 14988)
+++ gate/trunk/src/gate/creole/annic/apache/lucene/search/Query.java
2012-01-10 17:51:05 UTC (rev 14989)
@@ -23,18 +23,9 @@
import gate.creole.annic.apache.lucene.index.IndexReader;
-/** The abstract base class for queries.
- <p>Instantiable subclasses are:
- <ul>
- <li> {@link TermQuery}
- <li> {@link BooleanQuery}
- <li> {@link PhraseQuery}
- </ul>
- <p>A parser for queries is contained in:
- <ul>
- <li>{@link gate.creole.annic.apache.lucene.queryParser.QueryParser
QueryParser}
- </ul>
-*/
+/**
+ * The abstract base class for queries.
+ */
public abstract class Query implements java.io.Serializable, Cloneable {
private float boost = 1.0f; // query boost factor
@@ -50,11 +41,9 @@
*/
public float getBoost() { return boost; }
- /** Prints a query to a string, with <code>field</code> as the default field
- * for terms. <p>The representation used is one that is readable by
- * {@link gate.creole.annic.apache.lucene.queryParser.QueryParser
QueryParser}
- * (although, if the query was created by the parser, the printed
- * representation may not be exactly what was parsed).
+ /**
+ * Prints a query to a string, with <code>field</code> as the default field
+ * for terms.
*/
public abstract String toString(String field);
Modified: gate/trunk/src/gate/creole/annic/apache/lucene/search/Scorer.java
===================================================================
--- gate/trunk/src/gate/creole/annic/apache/lucene/search/Scorer.java
2012-01-10 17:03:21 UTC (rev 14988)
+++ gate/trunk/src/gate/creole/annic/apache/lucene/search/Scorer.java
2012-01-10 17:51:05 UTC (rev 14989)
@@ -49,11 +49,11 @@
public abstract boolean next(Searcher searcher) throws IOException;
/** Returns the current document number. Initially invalid, until {@link
- * #next()} is called the first time. */
+ * #next(Searcher))} is called the first time. */
public abstract int doc();
/** Returns the score of the current document. Initially invalid, until
- * {@link #next()} is called the first time. */
+ * {@link #next(Searcher))} is called the first time. */
public abstract float score(Searcher searcher) throws IOException;
/** Skips to the first match beyond the current whose document number is
Modified: gate/trunk/src/gate/creole/annic/apache/lucene/search/Weight.java
===================================================================
--- gate/trunk/src/gate/creole/annic/apache/lucene/search/Weight.java
2012-01-10 17:03:21 UTC (rev 14988)
+++ gate/trunk/src/gate/creole/annic/apache/lucene/search/Weight.java
2012-01-10 17:51:05 UTC (rev 14989)
@@ -27,7 +27,7 @@
* is then called on the top-level query to compute the query normalization
* factor (@link Similarity#queryNorm(float)}). This factor is then passed to
* {@link #normalize(float)}. At this point the weighting is complete and a
- * scorer may be constructed by calling {@link #scorer(IndexReader)}.
+ * scorer may be constructed by calling {@link #scorer(IndexReader, Searcher)}.
*/
public interface Weight extends java.io.Serializable {
Modified: gate/trunk/src/gate/html/NekoHtmlDocumentHandler.java
===================================================================
--- gate/trunk/src/gate/html/NekoHtmlDocumentHandler.java 2012-01-10
17:03:21 UTC (rev 14988)
+++ gate/trunk/src/gate/html/NekoHtmlDocumentHandler.java 2012-01-10
17:51:05 UTC (rev 14989)
@@ -613,7 +613,7 @@
* readable form for the final document. This method modifies the
* content of tmpDocContent.
*
- * @param t the Html tag encounted by the HTML parser
+ * @param tagName the Html tag encounted by the HTML parser
*/
protected void customizeAppearanceOfDocumentWithStartTag(String tagName) {
boolean modification = false;
@@ -657,7 +657,7 @@
* readable form for the final document. This method modifies the
* content of tmpDocContent.
*
- * @param t the Html tag encounted by the HTML parser
+ * @param tagName the Html tag encounted by the HTML parser
*/
protected void customizeAppearanceOfDocumentWithEndTag(String tagName) {
boolean modification = false;
Modified: gate/trunk/src/gate/security/SessionImpl.java
===================================================================
--- gate/trunk/src/gate/security/SessionImpl.java 2012-01-10 17:03:21 UTC
(rev 14988)
+++ gate/trunk/src/gate/security/SessionImpl.java 2012-01-10 17:51:05 UTC
(rev 14989)
@@ -88,10 +88,7 @@
/** returns the timeout (in minutes) of the session
- *
- * @see AccessControllerImpl#DEFAULT_SESSION_TIMEOUT_MIN
- *
- * */
+ */
public int getTimeout() {
return this.timeout;
Modified: gate/trunk/src/gate/util/ant/packager/GazetteerLists.java
===================================================================
--- gate/trunk/src/gate/util/ant/packager/GazetteerLists.java 2012-01-10
17:03:21 UTC (rev 14988)
+++ gate/trunk/src/gate/util/ant/packager/GazetteerLists.java 2012-01-10
17:51:05 UTC (rev 14989)
@@ -23,7 +23,7 @@
/**
* Class that extracts the list of gazetteer .lst files from a .def.
- * This class extends {@link Path} so it can be used as a nested element
+ * This class extends {@link DataType} so it can be used as a nested element
* within the extraresourcespath of a packagegapp task.
*/
public class GazetteerLists extends DataType implements ResourceCollection {
Modified:
gate/trunk/src/gate/util/persistence/UnconditionalRunningStrategyPersistence.java
===================================================================
---
gate/trunk/src/gate/util/persistence/UnconditionalRunningStrategyPersistence.java
2012-01-10 17:03:21 UTC (rev 14988)
+++
gate/trunk/src/gate/util/persistence/UnconditionalRunningStrategyPersistence.java
2012-01-10 17:51:05 UTC (rev 14989)
@@ -8,7 +8,7 @@
import java.io.Serializable;
/**
- * Persistent holder for {@link gate.creole.UnconditionalRunningStrategy}.
+ * Persistent holder for {@link
gate.creole.RunningStrategy.UnconditionalRunningStrategy}.
*/
public class UnconditionalRunningStrategyPersistence implements Persistence {
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Write once. Port to many.
Get the SDK and tools to simplify cross-platform app development. Create
new or port existing apps to sell to consumers worldwide. Explore the
Intel AppUpSM program developer opportunity. appdeveloper.intel.com/join
http://p.sf.net/sfu/intel-appdev
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
