Mailing List Archive

otis 02/02/13 16:58:46

Modified: src/java/org/apache/lucene/analysis/standard
ParseException.java
src/java/org/apache/lucene/index IndexReader.java
src/java/org/apache/lucene/queryParser QueryParser.jj
src/java/org/apache/lucene/search BooleanClause.java
BooleanQuery.java IndexSearcher.java
MultiSearcher.java Searcher.java
src/java/org/apache/lucene/store Lock.java
Log:
- Patched Javadocs.
Submitted by: Erik Hatcher

Revision Changes Path
1.2 +1 -1 jakarta-lucene/src/java/org/apache/lucene/analysis/standard/ParseException.java

Index: ParseException.java
===================================================================
RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/analysis/standard/ParseException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ParseException.java 18 Sep 2001 16:29:51 -0000 1.1
+++ ParseException.java 14 Feb 2002 00:58:46 -0000 1.2
@@ -22,7 +22,7 @@
* This constructor calls its super class with the empty string
* to force the "toString" method of parent class "Throwable" to
* print the error message in the form:
- * ParseException: <result of getMessage>
+ * ParseException: &lt;result of getMessage&gt;
*/
public ParseException(Token currentTokenVal,
int[][] expectedTokenSequencesVal,



1.8 +1 -1 jakarta-lucene/src/java/org/apache/lucene/index/IndexReader.java

Index: IndexReader.java
===================================================================
RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/index/IndexReader.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- IndexReader.java 8 Feb 2002 19:39:42 -0000 1.7
+++ IndexReader.java 14 Feb 2002 00:58:46 -0000 1.8
@@ -69,7 +69,7 @@
the static method {@link #open}.

<p> For efficiency, in this API documents are often referred to via
- <it>document numbers</it>, non-negative integers which each name a unique
+ <i>document numbers</i>, non-negative integers which each name a unique
document in the index. These document numbers are ephemeral--they may change
as documents are added to and deleted from an index. Clients should thus not
rely on a given document having the same number between sessions. */



1.11 +1 -1 jakarta-lucene/src/java/org/apache/lucene/queryParser/QueryParser.jj

Index: QueryParser.jj
===================================================================
RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/queryParser/QueryParser.jj,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- QueryParser.jj 28 Jan 2002 11:34:45 -0000 1.10
+++ QueryParser.jj 14 Feb 2002 00:58:46 -0000 1.11
@@ -94,7 +94,7 @@
* Thus, in BNF, the query grammar is:
* <pre>
* Query ::= ( Clause )*
- * Clause ::= ["+", "-"] [<TERM> ":"] ( <TERM> | "(" Query ")" )
+ * Clause ::= ["+", "-"] [&lt;TERM&gt; ":"] ( &lt;TERM&gt; | "(" Query ")" )
* </pre>
*
* @author Brian Goetz



1.2 +2 -2 jakarta-lucene/src/java/org/apache/lucene/search/BooleanClause.java

Index: BooleanClause.java
===================================================================
RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/BooleanClause.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BooleanClause.java 18 Sep 2001 16:29:55 -0000 1.1
+++ BooleanClause.java 14 Feb 2002 00:58:46 -0000 1.2
@@ -59,10 +59,10 @@
/** The query whose matching documents are combined by the boolean query. */
public Query query;
/** If true, documents documents which <i>do not</i>
- match this sub-query will <it>not</it> match the boolean query. */
+ match this sub-query will <i>not</i> match the boolean query. */
public boolean required = false;
/** If true, documents documents which <i>do</i>
- match this sub-query will <it>not</it> match the boolean query. */
+ match this sub-query will <i>not</i> match the boolean query. */
public boolean prohibited = false;

/** Constructs a BooleanClause with query <code>q</code>, required



1.3 +2 -2 jakarta-lucene/src/java/org/apache/lucene/search/BooleanQuery.java

Index: BooleanQuery.java
===================================================================
RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/BooleanQuery.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- BooleanQuery.java 10 Oct 2001 17:55:04 -0000 1.2
+++ BooleanQuery.java 14 Feb 2002 00:58:46 -0000 1.3
@@ -70,9 +70,9 @@
/** Adds a clause to a boolean query. Clauses may be:
<ul>
<li><code>required</code> which means that documents which <i>do not</i>
- match this sub-query will <it>not</it> match the boolean query;
+ match this sub-query will <i>not</i> match the boolean query;
<li><code>prohibited</code> which means that documents which <i>do</i>
- match this sub-query will <it>not</it> match the boolean query; or
+ match this sub-query will <i>not</i> match the boolean query; or
<li>neither, in which case matched documents are neither prohibited from
nor required to match the sub-query.
</ul>



1.3 +1 -1 jakarta-lucene/src/java/org/apache/lucene/search/IndexSearcher.java

Index: IndexSearcher.java
===================================================================
RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/IndexSearcher.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- IndexSearcher.java 25 Sep 2001 19:03:35 -0000 1.2
+++ IndexSearcher.java 14 Feb 2002 00:58:46 -0000 1.3
@@ -138,7 +138,7 @@
* <p>{@link HitCollector#collect(int,float)} is called for every non-zero
* scoring document.
*
- * <p>Applications should only use this if they need <it>all</it> of the
+ * <p>Applications should only use this if they need <i>all</i> of the
* matching documents. The high-level search API ({@link
* Searcher#search(Query)}) is usually more efficient, as it skips
* non-high-scoring hits.



1.3 +1 -1 jakarta-lucene/src/java/org/apache/lucene/search/MultiSearcher.java

Index: MultiSearcher.java
===================================================================
RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/MultiSearcher.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- MultiSearcher.java 25 Sep 2001 19:03:35 -0000 1.2
+++ MultiSearcher.java 14 Feb 2002 00:58:46 -0000 1.3
@@ -159,7 +159,7 @@
* <p>{@link HitCollector#collect(int,float)} is called for every non-zero
* scoring document.
*
- * <p>Applications should only use this if they need <it>all</it> of the
+ * <p>Applications should only use this if they need <i>all</i> of the
* matching documents. The high-level search API ({@link
* Searcher#search(Query)}) is usually more efficient, as it skips
* non-high-scoring hits.



1.3 +2 -2 jakarta-lucene/src/java/org/apache/lucene/search/Searcher.java

Index: Searcher.java
===================================================================
RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/Searcher.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Searcher.java 25 Sep 2001 19:03:35 -0000 1.2
+++ Searcher.java 14 Feb 2002 00:58:46 -0000 1.3
@@ -80,7 +80,7 @@
* <p>{@link HitCollector#collect(int,float)} is called for every non-zero
* scoring document.
*
- * <p>Applications should only use this if they need <it>all</it> of the
+ * <p>Applications should only use this if they need <i>all</i> of the
* matching documents. The high-level search API ({@link
* Searcher#search(Query)}) is usually more efficient, as it skips
* non-high-scoring hits. */
@@ -94,7 +94,7 @@
* <p>{@link HitCollector#collect(int,float)} is called for every non-zero
* scoring document.
*
- * <p>Applications should only use this if they need <it>all</it> of the
+ * <p>Applications should only use this if they need <i>all</i> of the
* matching documents. The high-level search API ({@link
* Searcher#search(Query)}) is usually more efficient, as it skips
* non-high-scoring hits.



1.2 +2 -2 jakarta-lucene/src/java/org/apache/lucene/store/Lock.java

Index: Lock.java
===================================================================
RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/store/Lock.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Lock.java 27 Sep 2001 16:27:02 -0000 1.1
+++ Lock.java 14 Feb 2002 00:58:46 -0000 1.2
@@ -60,7 +60,7 @@
* <p>Typical use might look like:<pre>
* new Lock.With(directory.makeLock("my.lock")) {
* public Object doBody() {
- * <it>... code to execute while locked ...</it>
+ * <i>... code to execute while locked ...</i>
* }
* }.run();
* </pre>
@@ -93,7 +93,7 @@
/** Code to execute with exclusive access. */
protected abstract Object doBody() throws IOException;

- /** Calls {@link #doBody} while <it>lock</it> is obtained. Blocks if lock
+ /** Calls {@link #doBody} while <i>lock</i> is obtained. Blocks if lock
* cannot be obtained immediately. Retries to obtain lock once per second
* until it is obtained, or until it has tried ten times. */
public Object run() throws IOException {




--
To unsubscribe, e-mail: <mailto:lucene-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:lucene-dev-help@jakarta.apache.org>