Return-Path: 
 <lucene-dev-return-712-qmlist-jakarta-archive-lucene-dev=jakarta.apache.org@jakarta.apache.org>
Delivered-To: apmail-jakarta-lucene-dev-archive@apache.org
Received: (qmail 11215 invoked from network); 10 Feb 2002 02:49:20 -0000
Received: from unknown (HELO nagoya.betaversion.org) (192.18.49.131)
  by daedalus.apache.org with SMTP; 10 Feb 2002 02:49:20 -0000
Received: (qmail 880 invoked by uid 97); 10 Feb 2002 02:49:28 -0000
Delivered-To: qmlist-jakarta-archive-lucene-dev@jakarta.apache.org
Received: (qmail 846 invoked by uid 97); 10 Feb 2002 02:49:28 -0000
Mailing-List: contact lucene-dev-help@jakarta.apache.org; run by ezmlm
Precedence: bulk
List-Unsubscribe: <mailto:lucene-dev-unsubscribe@jakarta.apache.org>
List-Subscribe: <mailto:lucene-dev-subscribe@jakarta.apache.org>
List-Help: <mailto:lucene-dev-help@jakarta.apache.org>
List-Post: <mailto:lucene-dev@jakarta.apache.org>
List-Id: "Lucene Developers List" <lucene-dev.jakarta.apache.org>
Reply-To: "Lucene Developers List" <lucene-dev@jakarta.apache.org>
Delivered-To: mailing list lucene-dev@jakarta.apache.org
Received: (qmail 833 invoked from network); 10 Feb 2002 02:49:27 -0000
X-Sent: 10 Feb 2002 02:49:21 GMT
Message-ID: <060701c1b1dd$89ec7b70$6401a8c0@darden.virginia.edu>
From: "Erik Hatcher" <lists@ehatchersolutions.com>
To: "Lucene Developers List" <lucene-dev@jakarta.apache.org>
Subject: documentation patch
Date: Sat, 9 Feb 2002 21:49:19 -0500
MIME-Version: 1.0
Content-Type: multipart/mixed;
	boundary="----=_NextPart_000_0604_01C1B1B3.A0A6C1B0"
X-Priority: 3
X-MSMail-Priority: Normal
X-Mailer: Microsoft Outlook Express 6.00.2600.0000
X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2600.0000
X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N
X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N

------=_NextPart_000_0604_01C1B1B3.A0A6C1B0
Content-Type: text/plain;
	charset="iso-8859-1"
Content-Transfer-Encoding: 7bit

I figure that by offering a documentation patch right off the bat that I'll
earn some brownie points..... :)

I started integrating my <index> task into Lucene's build locally (separate
set of targets and all - no worries I'm not going to break anything! :)

My HTML indexing code uses JTidy to DOM'ify HTML files. JTidy issues a lot
of warnings for bad HTML and it found a few things that were incorrect.
Attached is a documentation-only patch fixing up the bad HTML.

One note though: there is bad HTML in ParseException.java - "<result of
getMessage>".  Any idea how to get that corrected since its a JavaCC
generated comment?

I did this same process on Ant's documentation.... *whew* - this was a piece
of cake to fix (granted there are a ton more classes in Ant than Lucene
though).

    Erik

p.s. <it> ain't an HTML tag! :)

------=_NextPart_000_0604_01C1B1B3.A0A6C1B0
Content-Type: text/plain;
	name="docs-patch.txt"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: attachment;
	filename="docs-patch.txt"

cvs -q diff -u =
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 =
src/java/org/apache/lucene/search/BooleanQuery.java =
src/java/org/apache/lucene/search/IndexSearcher.java =
src/java/org/apache/lucene/search/MultiSearcher.java =
src/java/org/apache/lucene/search/Searcher.java =
src/java/org/apache/lucene/store/Lock.java=20
Index: src/java/org/apache/lucene/analysis/standard/ParseException.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: =
/home/cvspublic/jakarta-lucene/src/java/org/apache/lucene/analysis/standa=
rd/ParseException.java,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 ParseException.java
--- src/java/org/apache/lucene/analysis/standard/ParseException.java	18 =
Sep 2001 16:29:51 -0000	1.1.1.1
+++ src/java/org/apache/lucene/analysis/standard/ParseException.java	10 =
Feb 2002 02:29:21 -0000
@@ -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,
Index: src/java/org/apache/lucene/index/IndexReader.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: =
/home/cvspublic/jakarta-lucene/src/java/org/apache/lucene/index/IndexRead=
er.java,v
retrieving revision 1.7
diff -u -r1.7 IndexReader.java
--- src/java/org/apache/lucene/index/IndexReader.java	8 Feb 2002 =
19:39:42 -0000	1.7
+++ src/java/org/apache/lucene/index/IndexReader.java	10 Feb 2002 =
02:29:22 -0000
@@ -69,7 +69,7 @@
   the static method {@link #open}.
=20
   <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. */
Index: src/java/org/apache/lucene/queryParser/QueryParser.jj
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: =
/home/cvspublic/jakarta-lucene/src/java/org/apache/lucene/queryParser/Que=
ryParser.jj,v
retrieving revision 1.10
diff -u -r1.10 QueryParser.jj
--- src/java/org/apache/lucene/queryParser/QueryParser.jj	28 Jan 2002 =
11:34:45 -0000	1.10
+++ src/java/org/apache/lucene/queryParser/QueryParser.jj	10 Feb 2002 =
02:29:23 -0000
@@ -94,7 +94,7 @@
  * Thus, in BNF, the query grammar is:
  * <pre>
  *   Query  ::=3D ( Clause )*
- *   Clause ::=3D ["+", "-"] [<TERM> ":"] ( <TERM> | "(" Query ")" )
+ *   Clause ::=3D ["+", "-"] [&lt;TERM&gt; ":"] ( &lt;TERM&gt; | "(" =
Query ")" )
  * </pre>
  *
  * @author Brian Goetz
Index: src/java/org/apache/lucene/search/BooleanClause.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: =
/home/cvspublic/jakarta-lucene/src/java/org/apache/lucene/search/BooleanC=
lause.java,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 BooleanClause.java
--- src/java/org/apache/lucene/search/BooleanClause.java	18 Sep 2001 =
16:29:55 -0000	1.1.1.1
+++ src/java/org/apache/lucene/search/BooleanClause.java	10 Feb 2002 =
02:29:23 -0000
@@ -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 =3D 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 =3D false;
  =20
   /** Constructs a BooleanClause with query <code>q</code>, required
Index: src/java/org/apache/lucene/search/BooleanQuery.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: =
/home/cvspublic/jakarta-lucene/src/java/org/apache/lucene/search/BooleanQ=
uery.java,v
retrieving revision 1.2
diff -u -r1.2 BooleanQuery.java
--- src/java/org/apache/lucene/search/BooleanQuery.java	10 Oct 2001 =
17:55:04 -0000	1.2
+++ src/java/org/apache/lucene/search/BooleanQuery.java	10 Feb 2002 =
02:29:23 -0000
@@ -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>
Index: src/java/org/apache/lucene/search/IndexSearcher.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: =
/home/cvspublic/jakarta-lucene/src/java/org/apache/lucene/search/IndexSea=
rcher.java,v
retrieving revision 1.2
diff -u -r1.2 IndexSearcher.java
--- src/java/org/apache/lucene/search/IndexSearcher.java	25 Sep 2001 =
19:03:35 -0000	1.2
+++ src/java/org/apache/lucene/search/IndexSearcher.java	10 Feb 2002 =
02:29:24 -0000
@@ -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.
Index: src/java/org/apache/lucene/search/MultiSearcher.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: =
/home/cvspublic/jakarta-lucene/src/java/org/apache/lucene/search/MultiSea=
rcher.java,v
retrieving revision 1.2
diff -u -r1.2 MultiSearcher.java
--- src/java/org/apache/lucene/search/MultiSearcher.java	25 Sep 2001 =
19:03:35 -0000	1.2
+++ src/java/org/apache/lucene/search/MultiSearcher.java	10 Feb 2002 =
02:29:24 -0000
@@ -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.
Index: src/java/org/apache/lucene/search/Searcher.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: =
/home/cvspublic/jakarta-lucene/src/java/org/apache/lucene/search/Searcher=
.java,v
retrieving revision 1.2
diff -u -r1.2 Searcher.java
--- src/java/org/apache/lucene/search/Searcher.java	25 Sep 2001 19:03:35 =
-0000	1.2
+++ src/java/org/apache/lucene/search/Searcher.java	10 Feb 2002 02:29:24 =
-0000
@@ -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.
Index: src/java/org/apache/lucene/store/Lock.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: =
/home/cvspublic/jakarta-lucene/src/java/org/apache/lucene/store/Lock.java=
,v
retrieving revision 1.1
diff -u -r1.1 Lock.java
--- src/java/org/apache/lucene/store/Lock.java	27 Sep 2001 16:27:02 =
-0000	1.1
+++ src/java/org/apache/lucene/store/Lock.java	10 Feb 2002 02:29:25 =
-0000
@@ -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;
=20
-    /** 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 {


------=_NextPart_000_0604_01C1B1B3.A0A6C1B0
Content-Type: text/plain; charset=us-ascii

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