From 80f9f1db38568ccad423143a9624a429c484cd91 Mon Sep 17 00:00:00 2001 From: Otis Gospodnetic Date: Thu, 14 Feb 2002 01:46:31 +0000 Subject: [PATCH] - Replaced references to the old package name com.lucene with org.apache.lucene - Fixed a few Javadocs problems. PR: Obtained from: Submitted by: Reviewed by: git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@149681 13f79535-47bb-0310-9956-ffa450edef68 --- docs/index.html | 8 ++++++++ docs/resources.html | 8 ++++++++ docs/whoweare.html | 8 ++++++++ src/java/org/apache/lucene/manifest | 4 ++-- .../apache/lucene/queryParser/QueryParser.jj | 8 ++++++-- .../org/apache/lucene/queryParser/package.html | 2 +- .../org/apache/lucene/store/FSDirectory.java | 4 ++-- src/java/overview.html | 18 +++++++++--------- 8 files changed, 44 insertions(+), 16 deletions(-) diff --git a/docs/index.html b/docs/index.html index ebed1ec2a07..fdd1c3f1e4b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -18,6 +18,8 @@ + + Jakarta Lucene - Overview - Jakarta Lucene @@ -188,3 +190,9 @@ developed in an open and cooperative fashion. + + + + + + diff --git a/docs/resources.html b/docs/resources.html index 64790e80218..8f8fa39fa35 100644 --- a/docs/resources.html +++ b/docs/resources.html @@ -16,6 +16,8 @@ + + Jakarta Lucene - Resources - Jakarta Lucene @@ -139,3 +141,9 @@ + + + + + + diff --git a/docs/whoweare.html b/docs/whoweare.html index bec1547b129..9fc886e0b0e 100644 --- a/docs/whoweare.html +++ b/docs/whoweare.html @@ -16,6 +16,8 @@ + + Jakarta Lucene - Who We Are - Jakarta Lucene @@ -191,3 +193,9 @@ the Jakarta-Lucene mailing li + + + + + + diff --git a/src/java/org/apache/lucene/manifest b/src/java/org/apache/lucene/manifest index 9421cc6f3b9..a8f07da4174 100644 --- a/src/java/org/apache/lucene/manifest +++ b/src/java/org/apache/lucene/manifest @@ -1,8 +1,8 @@ -Name: com/lucene +Name: org/apache/lucene Specification-Title: Lucene Search Engine Specification-Version: $Name$ Specification-Vendor: Lucene -Implementation-Title: com.lucene +Implementation-Title: org.apache.lucene Implementation-Version: $Name$ $Date$ Implementation-Vendor: Lucene diff --git a/src/java/org/apache/lucene/queryParser/QueryParser.jj b/src/java/org/apache/lucene/queryParser/QueryParser.jj index c3ba709a6da..571f770139d 100644 --- a/src/java/org/apache/lucene/queryParser/QueryParser.jj +++ b/src/java/org/apache/lucene/queryParser/QueryParser.jj @@ -97,12 +97,16 @@ import org.apache.lucene.search.*; * Clause ::= ["+", "-"] [<TERM> ":"] ( <TERM> | "(" Query ")" ) * * + *

+ * Examples of appropriately formatted queries can be found in the test cases. + *

+ * * @author Brian Goetz */ public class QueryParser { - /** Parses a query string, returning a - * Query. + /** Parses a query string, returning a {@link org.apache.lucene.search.Query}. * @param query the query string to be parsed. * @param field the default field for query terms. * @param analyzer used to find terms in the query text. diff --git a/src/java/org/apache/lucene/queryParser/package.html b/src/java/org/apache/lucene/queryParser/package.html index 5a3b8368794..cfbc0815aa5 100644 --- a/src/java/org/apache/lucene/queryParser/package.html +++ b/src/java/org/apache/lucene/queryParser/package.html @@ -9,7 +9,7 @@ A simple query parser implemented with JavaCC.

Note that JavaCC defines lots of public, classes, methods and fields that do not need to be public.  These clutter the documentation.  Sorry. -

Note that because JavaCC defines a class named Token, com.lucene.analysis.Token +

Note that because JavaCC defines a class named Token, org.apache.lucene.analysis.Token must always be fully qualified in sourced code in this package. diff --git a/src/java/org/apache/lucene/store/FSDirectory.java b/src/java/org/apache/lucene/store/FSDirectory.java index 7bf4e1df583..3961bb2d1e9 100644 --- a/src/java/org/apache/lucene/store/FSDirectory.java +++ b/src/java/org/apache/lucene/store/FSDirectory.java @@ -85,7 +85,7 @@ final public class FSDirectory extends Directory { * * @param path the path to the directory. * @param create if true, create, or erase any existing contents. - * @returns the FSDirectory for the named file. */ + * @return the FSDirectory for the named file. */ public static FSDirectory getDirectory(String path, boolean create) throws IOException { return getDirectory(new File(path), create); @@ -99,7 +99,7 @@ final public class FSDirectory extends Directory { * * @param file the path to the directory. * @param create if true, create, or erase any existing contents. - * @returns the FSDirectory for the named file. */ + * @return the FSDirectory for the named file. */ public static FSDirectory getDirectory(File file, boolean create) throws IOException { file = new File(file.getCanonicalPath()); diff --git a/src/java/overview.html b/src/java/overview.html index 17d62be6493..50b75520a67 100644 --- a/src/java/overview.html +++ b/src/java/overview.html @@ -8,12 +8,12 @@ The Jakarta Lucene API is divided into several packages:

@@ -68,7 +68,7 @@ adding
  • Create an IndexWriter -and add documents to to it with addDocument();
    • +and add documents to to it with addDocument();
  • Call QueryParser.parse() @@ -76,7 +76,7 @@ to build a query from a string; and
  • Create an IndexSearcher -and pass the query to it's search() +and pass the query to it's search() method.
    • Some simple examples of code which does this are: