mirror of
https://github.com/apache/lucene.git
synced 2025-02-20 17:07:09 +00:00
javadoc fixup
git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@164742 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Erik Hatcher
parent
f7023a936d
commit
790dfc1490
52
build.xml
52
build.xml
@ -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 &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 &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>
|
||||
@ -681,6 +698,13 @@
|
||||
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"/>
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ import java.util.*;
|
||||
|
||||
/**
|
||||
* 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 @@ public final class SynExpand {
|
||||
*
|
||||
* @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"
|
||||
*
|
||||
|
||||
@ -24,18 +24,18 @@ import java.util.TreeMap;
|
||||
|
||||
/**
|
||||
* 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
|
||||
|
||||
@ -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>
|
||||
|
||||
|
||||
@ -74,7 +74,7 @@ public class CJKAnalyzer extends Analyzer {
|
||||
|
||||
/**
|
||||
* 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",
|
||||
|
||||
@ -39,7 +39,7 @@ import java.util.*;
|
||||
/**
|
||||
* <p>
|
||||
* Spell Checker class (Main class) <br/>
|
||||
* (initially inspired by the David Spencer code)
|
||||
* (initially inspired by the David Spencer code).
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
|
||||
@ -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>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user