lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ehatc...@apache.org
Subject svn commit: r164742 - in /lucene/java/trunk: ./ contrib/WordNet/src/java/org/apache/lucene/wordnet/ contrib/analyzers/src/java/org/apache/lucene/analysis/cjk/ contrib/spellchecker/src/java/org/apache/lucene/search/spell/ contrib/swing/src/java/org/apache/lucene/swing/models/
Date Tue, 26 Apr 2005 04:41:55 GMT
Author: ehatcher
Date: Mon Apr 25 21:41:54 2005
New Revision: 164742

URL: http://svn.apache.org/viewcvs?rev=164742&view=rev
Log:
javadoc fixup

Modified:
    lucene/java/trunk/build.xml
    lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/SynExpand.java
    lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/Syns2Index.java
    lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/package.html
    lucene/java/trunk/contrib/analyzers/src/java/org/apache/lucene/analysis/cjk/CJKAnalyzer.java
    lucene/java/trunk/contrib/spellchecker/src/java/org/apache/lucene/search/spell/SpellChecker.java
    lucene/java/trunk/contrib/swing/src/java/org/apache/lucene/swing/models/package.html

Modified: lucene/java/trunk/build.xml
URL: http://svn.apache.org/viewcvs/lucene/java/trunk/build.xml?rev=164742&r1=164741&r2=164742&view=diff
==============================================================================
--- lucene/java/trunk/build.xml (original)
+++ lucene/java/trunk/build.xml Mon Apr 25 21:41:54 2005
@@ -416,21 +416,38 @@
     <attribute name="destdir"/>
     <sequential>
       <javadoc
-        sourcepath="src/java"
-        overview="src/java/overview.html"
-        packagenames="org.apache.lucene.*"
-        destdir="@{destdir}"
-        access="@{access}"
-        encoding="${build.encoding}"
-        author="true"
-        version="true"
-        use="true"
-        link="${javadoc.link}"
-        windowtitle="${Name} ${version} API"
-        doctitle="${Name} ${version} API"
-        bottom="Copyright &amp;copy; ${year} Apache Software Foundation.  All Rights
Reserved."
-      >
+          overview="src/java/overview.html"
+          packagenames="org.apache.lucene.*"
+          destdir="@{destdir}"
+          access="@{access}"
+          encoding="${build.encoding}"
+          author="true"
+          version="true"
+          use="true"
+          link="${javadoc.link}"
+          windowtitle="${Name} ${version} API"
+          doctitle="${Name} ${version} API"
+          bottom="Copyright &amp;copy; ${year} Apache Software Foundation.  All Rights
Reserved.">
         <tag name="todo" description="To Do:"/>
+
+        <!-- TODO: find a dynamic way to do include multiple source roots -->
+        <packageset dir="src/java"/>
+        <packageset dir="contrib/analyzers/src/java"/>
+        <packageset dir="contrib/WordNet/src/java"/>
+        <packageset dir="contrib/highlighter/src/java"/>
+        <packageset dir="contrib/similarity/src/java"/>
+        <packageset dir="contrib/spellchecker/src/java"/>
+        <packageset dir="contrib/snowball/src/java"/>
+        <packageset dir="contrib/swing/src/java"/>
+
+        <group title="Core" packages="org.apache.*:org.apache.lucene.analysis.standard.*"/>
+        <group title="Snowball" packages="org.apache.lucene.analysis.snowball.*:net.sf.*"/>
+        <group title="Analysis" packages="org.apache.lucene.analysis.*"/>
+        <group title="Highlighter" packages="org.apache.lucene.search.highlight.*"/>
+        <group title="MorLikeThis" packages="org.apache.lucene.search.similar.*"/>
+        <group title="SpellChecker" packages="org.apache.lucene.search.spell.*"/>
+        <group title="Swing" packages="org.apache.lucene.swing.*"/>
+        <group title="WordNet" packages="org.apache.lucene.wordnet.*"/>
       </javadoc>
     </sequential>
   </macrodef>
@@ -680,6 +697,13 @@
     <invoke-javacc target="src/demo/org/apache/lucene/demo/html/HTMLParser.jj"
                    outputDir="src/demo/org/apache/lucene/demo/html"
     />
+  </target>
+  
+  <target name="build-contrib" depends="compile-test">
+    <mkdir dir="${build.dir}/contrib"/>
+    <ant antfile="contrib/build.xml" inheritall="false">
+      <property name="dist.dir" location="${build.dir}/contrib"/>
+    </ant>
   </target>
 
   <target name="default" depends="jar-core"/>

Modified: lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/SynExpand.java
URL: http://svn.apache.org/viewcvs/lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/SynExpand.java?rev=164742&r1=164741&r2=164742&view=diff
==============================================================================
--- lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/SynExpand.java (original)
+++ lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/SynExpand.java Mon
Apr 25 21:41:54 2005
@@ -12,7 +12,7 @@
 
 /**
  * Expand a query by looking up synonyms for every term.
- * You need to invoke {@see Syns2Index} first to build the synonym index.
+ * You need to invoke {@link Syns2Index} first to build the synonym index.
  *
  * @see Syns2Index
  */
@@ -58,9 +58,9 @@
 	 *
 	 * @param query users query that is assumed to not have any "special" query syntax, thus
it should be just normal words, so "big dog" makes sense, but a query like "title:foo^1.2"
doesn't as this should presumably be passed directly to the default query parser.
 	 *
-	 * @param syns a opened to the Lucene index you previously created with {@see Syns2Index}.
The searcher is not closed or otherwise altered.
+	 * @param syns a opened to the Lucene index you previously created with {@link Syns2Index}.
The searcher is not closed or otherwise altered.
 	 *
-	 * @param a optional analyzer used to parse the users query else {@see StandardAnalzyer}
is used
+	 * @param a optional analyzer used to parse the users query else {@link StandardAnalyzer}
is used
 	 *
 	 * @param field optional field name to search in or null if you want the default of "contents"
 	 *

Modified: lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/Syns2Index.java
URL: http://svn.apache.org/viewcvs/lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/Syns2Index.java?rev=164742&r1=164741&r2=164742&view=diff
==============================================================================
--- lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/Syns2Index.java (original)
+++ lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/Syns2Index.java Mon
Apr 25 21:41:54 2005
@@ -24,18 +24,18 @@
 
 /**
  * Convert the prolog file wn_s.pl from the <a href="http://www.cogsci.princeton.edu/2.0/WNprolog-2.0.tar.gz">WordNet
prolog download</a>
- * into a Lucene index suitable for looking up synonyms and performing query expansion ({@see
SynExpand#expand SynExpand.expand(...)}).
+ * into a Lucene index suitable for looking up synonyms and performing query expansion ({@link
SynExpand#expand SynExpand.expand(...)}).
  *
  * This has been tested with WordNet 2.0.
  *
- * The index has fields named "word" ({@see #F_WORD})
- * and "syn" ({@see #F_SYN}).
+ * The index has fields named "word" ({@link #F_WORD})
+ * and "syn" ({@link #F_SYN}).
  * <p>
  * The source word (such as 'big') can be looked up in the
  * "word" field, and if present there will be fields named "syn"
  * for every synonym. What's tricky here is that there could be <b>multiple</b>
  * fields with the same name, in the general case for words that have multiple synonyms.
- * That's not a problem with Lucene, you just use {@see org.apache.lucene.document.Document#getValues}
+ * That's not a problem with Lucene, you just use {@link org.apache.lucene.document.Document#getValues}
  * </p>
  * <p>
  * While the WordNet file distinguishes groups of synonyms with

Modified: lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/package.html
URL: http://svn.apache.org/viewcvs/lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/package.html?rev=164742&r1=164741&r2=164742&view=diff
==============================================================================
--- lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/package.html (original)
+++ lucene/java/trunk/contrib/WordNet/src/java/org/apache/lucene/wordnet/package.html Mon
Apr 25 21:41:54 2005
@@ -7,8 +7,8 @@
     This package uses synonyms defined by <a href="http://www.cogsci.princeton.edu/~wn/">WordNet</a>
to build a
     Lucene index storing them, which in turn can be used for query expansion.
 
-    You normally run {@see org.apache.lucene.wordnet.Syns2Index} once to build the query
index/"database", and then call
-    {@see org.apache.lucene.wordnet.SynExpand#expand SynExpand.expand(...)} to expand a query.
+    You normally run {@link org.apache.lucene.wordnet.Syns2Index} once to build the query
index/"database", and then call
+    {@link org.apache.lucene.wordnet.SynExpand#expand SynExpand.expand(...)} to expand a
query.
 
     <p>
 

Modified: lucene/java/trunk/contrib/analyzers/src/java/org/apache/lucene/analysis/cjk/CJKAnalyzer.java
URL: http://svn.apache.org/viewcvs/lucene/java/trunk/contrib/analyzers/src/java/org/apache/lucene/analysis/cjk/CJKAnalyzer.java?rev=164742&r1=164741&r2=164742&view=diff
==============================================================================
--- lucene/java/trunk/contrib/analyzers/src/java/org/apache/lucene/analysis/cjk/CJKAnalyzer.java
(original)
+++ lucene/java/trunk/contrib/analyzers/src/java/org/apache/lucene/analysis/cjk/CJKAnalyzer.java
Mon Apr 25 21:41:54 2005
@@ -74,7 +74,7 @@
 
   /**
    * An array containing some common English words that are not usually
-   * useful for searching. and some double-byte interpunctions.....
+   * useful for searching and some double-byte interpunctions.
    */
   public final static String[] STOP_WORDS = {
     "a", "and", "are", "as", "at", "be",

Modified: lucene/java/trunk/contrib/spellchecker/src/java/org/apache/lucene/search/spell/SpellChecker.java
URL: http://svn.apache.org/viewcvs/lucene/java/trunk/contrib/spellchecker/src/java/org/apache/lucene/search/spell/SpellChecker.java?rev=164742&r1=164741&r2=164742&view=diff
==============================================================================
--- lucene/java/trunk/contrib/spellchecker/src/java/org/apache/lucene/search/spell/SpellChecker.java
(original)
+++ lucene/java/trunk/contrib/spellchecker/src/java/org/apache/lucene/search/spell/SpellChecker.java
Mon Apr 25 21:41:54 2005
@@ -39,7 +39,7 @@
 /**
  *  <p>
  *	Spell Checker class  (Main class) <br/>
- * (initially inspired by the David Spencer code)
+ * (initially inspired by the David Spencer code).
  *  </p>
  *  
  *  <p>

Modified: lucene/java/trunk/contrib/swing/src/java/org/apache/lucene/swing/models/package.html
URL: http://svn.apache.org/viewcvs/lucene/java/trunk/contrib/swing/src/java/org/apache/lucene/swing/models/package.html?rev=164742&r1=164741&r2=164742&view=diff
==============================================================================
--- lucene/java/trunk/contrib/swing/src/java/org/apache/lucene/swing/models/package.html (original)
+++ lucene/java/trunk/contrib/swing/src/java/org/apache/lucene/swing/models/package.html Mon
Apr 25 21:41:54 2005
@@ -1,5 +1,5 @@
 <html>
 <body>
-Decorators for JTable TableModel and JList ListModel encapsulating Lucene indexing and searching
functionality. .
+Decorators for JTable TableModel and JList ListModel encapsulating Lucene indexing and searching
functionality.
 </body>
 </html>



Mime
View raw message