Author: jerome Date: Fri Aug 26 14:03:19 2005 New Revision: 240345 URL: http://svn.apache.org/viewcvs?rev=240345&view=rev Log: NUTCH-37, no more javadoc warnings
Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/clustering/OnlineClusterer.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/fs/NutchFileSystem.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/FileSplit.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/MapOutputFile.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/RecordReader.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/package.html lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/parse/Parse.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/Content.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ProtocolException.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ResourceGone.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ResourceMoved.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/RetryLater.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/searcher/Hits.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/segment/SegmentReader.java lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/util/Daemon.java lucene/nutch/branches/Release-0.7/src/plugin/languageidentifier/src/java/org/apache/nutch/analysis/lang/LanguageIdentifier.java lucene/nutch/branches/Release-0.7/src/plugin/parse-html/src/java/org/apache/nutch/parse/html/DOMBuilder.java lucene/nutch/branches/Release-0.7/src/plugin/parse-html/src/java/org/apache/nutch/parse/html/XMLCharacterRecognizer.java lucene/nutch/branches/Release-0.7/src/plugin/protocol-httpclient/src/java/org/apache/nutch/protocol/httpclient/DummySSLProtocolSocketFactory.java Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/clustering/OnlineClusterer.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/clustering/OnlineClusterer.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/clustering/OnlineClusterer.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/clustering/OnlineClusterer.java Fri Aug 26 14:03:19 2005 @@ -23,8 +23,8 @@ * algorithms. * * <p>By the term <b>online</b> search results clustering we will understand - * a clusterer that works on a set of [EMAIL PROTECTED] Hit}s retrieved for a user's query - * and produces a set of [EMAIL PROTECTED] Clusters} that can be displayed to help + * a clusterer that works on a set of [EMAIL PROTECTED] HitDetails} retrieved for a user's + * query and produces a set of [EMAIL PROTECTED] HitsCluster} that can be displayed to help * the user gain insight in the topics found in the result.</p> * * <p>Other clustering options include predefined categories and off-line Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/fs/NutchFileSystem.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/fs/NutchFileSystem.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/fs/NutchFileSystem.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/fs/NutchFileSystem.java Fri Aug 26 14:03:19 2005 @@ -80,8 +80,8 @@ return getNamed(NutchConf.get().get("fs.default.name", "local")); } - /** Returns a name for this filesystem, suitable to pass to [EMAIL PROTECTED] - * NutchFileSystem#getNamed(String).*/ + /** Returns a name for this filesystem, suitable to pass to + * [EMAIL PROTECTED] NutchFileSystem#getNamed(String)}.*/ public abstract String getName(); /** Returns a named filesystem. Names are either the string "local" or a Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/FileSplit.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/FileSplit.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/FileSplit.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/FileSplit.java Fri Aug 26 14:03:19 2005 @@ -25,9 +25,12 @@ import org.apache.nutch.io.UTF8; import org.apache.nutch.fs.NutchFileSystem; -/** A section of an input file. Returned by [EMAIL PROTECTED] - * InputFormat#getSplits(File[], int)} and passed to - * InputFormat#getRecordReader(FileSplit). */ +/** + * A section of an input file. + * Returned by [EMAIL PROTECTED] InputFormat#getSplits(NutchFileSystem, JobConf, int)} + * and passed to + * [EMAIL PROTECTED] InputFormat#getRecordReader(NutchFileSystem, FileSplit, JobConf)}. + */ public class FileSplit implements Writable { private File file; private long start; Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/MapOutputFile.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/MapOutputFile.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/MapOutputFile.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/MapOutputFile.java Fri Aug 26 14:03:19 2005 @@ -42,7 +42,7 @@ /** Create a local reduce input file name. * @param mapTaskId a map task id - * @param partition a reduce partition + * @param reduceTaskId a reduce task id */ public static File getInputFile(String mapTaskId, String reduceTaskId) { File taskDir = new File(LOCAL_DIR, reduceTaskId); Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/RecordReader.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/RecordReader.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/RecordReader.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/RecordReader.java Fri Aug 26 14:03:19 2005 @@ -22,7 +22,7 @@ import org.apache.nutch.io.WritableComparable; import org.apache.nutch.io.Writable; -/** Reads key/value pairs from an input file [EMAIL PROTECTED] InputFormat.Split}. +/** Reads key/value pairs from an input file [EMAIL PROTECTED] FileSplit}. * Implemented by [EMAIL PROTECTED] InputFormat} implementations. */ public interface RecordReader { /** Reads the next key/value pair. Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/package.html URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/package.html?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/package.html (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/mapReduce/package.html Fri Aug 26 14:03:19 2005 @@ -6,7 +6,7 @@ <p>Applications implement [EMAIL PROTECTED] org.apache.nutch.mapReduce.Mapper} and [EMAIL PROTECTED] org.apache.nutch.mapReduce.Reducer} interfaces. These are submitted -as a [EMAIL PROTECTED] org.apache.nutch.mapReduce.MapReduceJob} and are applied to data +as a MapReduceJob and are applied to data stored in a [EMAIL PROTECTED] org.apache.nutch.fs.NutchFileSystem}.</p> <p>See <a href="http://labs.google.com/papers/mapreduce.html">Google's Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/parse/Parse.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/parse/Parse.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/parse/Parse.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/parse/Parse.java Fri Aug 26 14:03:19 2005 @@ -17,7 +17,7 @@ package org.apache.nutch.parse; /** The result of parsing a page's raw content. - * @see Parser#getParse(FetcherOutput,Content) + * @see Parser#getParse(Content) */ public interface Parse { Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/Content.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/Content.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/Content.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/Content.java Fri Aug 26 14:03:19 2005 @@ -114,7 +114,8 @@ public void setContent(byte[] content) { this.content = content; } /** The media type of the retrieved content. - * @see http://www.iana.org/assignments/media-types/ + * @see <a href="http://www.iana.org/assignments/media-types/"> + * http://www.iana.org/assignments/media-types/</a> */ public String getContentType() { return contentType; } public void setContentType(String contentType) { Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ProtocolException.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ProtocolException.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ProtocolException.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ProtocolException.java Fri Aug 26 14:03:19 2005 @@ -18,7 +18,6 @@ import java.net.URL; -/** Thrown by [EMAIL PROTECTED] Protocol#getContent(String)}.*/ public class ProtocolException extends Exception { public ProtocolException() { Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ResourceGone.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ResourceGone.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ResourceGone.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ResourceGone.java Fri Aug 26 14:03:19 2005 @@ -19,7 +19,7 @@ import java.io.IOException; import java.net.URL; -/** Thrown by [EMAIL PROTECTED] Protocol#getContent(String)} when a [EMAIL PROTECTED] URL} is invalid.*/ +/** Thrown when a resource is invalid. */ public class ResourceGone extends ProtocolException { private URL url; Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ResourceMoved.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ResourceMoved.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ResourceMoved.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/ResourceMoved.java Fri Aug 26 14:03:19 2005 @@ -19,8 +19,7 @@ import java.io.IOException; import java.net.URL; -/** Thrown by [EMAIL PROTECTED] Protocol#getContent(String)} when a [EMAIL PROTECTED] URL} no longer - * exists.*/ +/** Thrown when a resource no longer exists.*/ public class ResourceMoved extends IOException { private URL oldUrl; private URL newUrl; Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/RetryLater.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/RetryLater.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/RetryLater.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/protocol/RetryLater.java Fri Aug 26 14:03:19 2005 @@ -19,8 +19,7 @@ import java.io.IOException; import java.net.URL; -/** Thrown by [EMAIL PROTECTED] Protocol#getContent(String)} when a [EMAIL PROTECTED] URL} should be - * retried later.*/ +/** Thrown when a resource should be retried later.*/ public class RetryLater extends ProtocolException { private URL url; Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/searcher/Hits.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/searcher/Hits.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/searcher/Hits.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/searcher/Hits.java Fri Aug 26 14:03:19 2005 @@ -44,14 +44,14 @@ } /** Returns the total number of hits for this query. This may be an estimate - * when (@link totalIsExact()} is false. */ + * when (@link #totalIsExact()} is false. */ public long getTotal() { return total; } - /** True if [EMAIL PROTECTED] getTotal()} gives the exact number of hits, or false if + /** True if [EMAIL PROTECTED] #getTotal()} gives the exact number of hits, or false if * it is only an estimate of the total number of hits. */ public boolean totalIsExact() { return totalIsExact; } - /** Set [EMAIL PROTECTED] totalIsExact()}. */ + /** Set [EMAIL PROTECTED] #totalIsExact()}. */ public void setTotalIsExact(boolean isExact) { totalIsExact = isExact; } /** Returns the number of hits included in this current listing. */ Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/segment/SegmentReader.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/segment/SegmentReader.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/segment/SegmentReader.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/segment/SegmentReader.java Fri Aug 26 14:03:19 2005 @@ -179,7 +179,8 @@ * @param withParseText if true, fix parse_text, otherwise ignore it * @param withParseData if true, fix parse_data, otherwise ignore it * @param dryrun if true, only show what would be done without performing any actions - * @return + * @return <code>true</code> if segment was fixed successfully, otherwise + * return <code>false</code>. */ public static boolean fixSegment(NutchFileSystem nfs, File dir, boolean withContent, boolean withParseText, boolean withParseData, Modified: lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/util/Daemon.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/util/Daemon.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/util/Daemon.java (original) +++ lucene/nutch/branches/Release-0.7/src/java/org/apache/nutch/util/Daemon.java Fri Aug 26 14:03:19 2005 @@ -16,7 +16,7 @@ package org.apache.nutch.util; -/** A thread that has called [EMAIL PROTECTED] Thread#SetDaemon(boolean) } with true.*/ +/** A thread that has called [EMAIL PROTECTED] Thread#setDaemon(boolean) } with true.*/ public class Daemon extends Thread { { Modified: lucene/nutch/branches/Release-0.7/src/plugin/languageidentifier/src/java/org/apache/nutch/analysis/lang/LanguageIdentifier.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/plugin/languageidentifier/src/java/org/apache/nutch/analysis/lang/LanguageIdentifier.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/plugin/languageidentifier/src/java/org/apache/nutch/analysis/lang/LanguageIdentifier.java (original) +++ lucene/nutch/branches/Release-0.7/src/plugin/languageidentifier/src/java/org/apache/nutch/analysis/lang/LanguageIdentifier.java Fri Aug 26 14:03:19 2005 @@ -52,7 +52,7 @@ * Identify the language of a content, based on statistical analysis. * * @see <a href="http://www.w3.org/WAI/ER/IG/ert/iso639.htm">ISO 639 - * Language Codes</a>. + * Language Codes</a> * * @author Sami Siren * @author Jérôme Charron Modified: lucene/nutch/branches/Release-0.7/src/plugin/parse-html/src/java/org/apache/nutch/parse/html/DOMBuilder.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/plugin/parse-html/src/java/org/apache/nutch/parse/html/DOMBuilder.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/plugin/parse-html/src/java/org/apache/nutch/parse/html/DOMBuilder.java (original) +++ lucene/nutch/branches/Release-0.7/src/plugin/parse-html/src/java/org/apache/nutch/parse/html/DOMBuilder.java Fri Aug 26 14:03:19 2005 @@ -42,7 +42,6 @@ * This class takes SAX events (in addition to some extra events * that SAX doesn't handle yet) and adds the result to a document * or document fragment. - * @xsl.usage general */ public class DOMBuilder implements ContentHandler, LexicalHandler Modified: lucene/nutch/branches/Release-0.7/src/plugin/parse-html/src/java/org/apache/nutch/parse/html/XMLCharacterRecognizer.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/plugin/parse-html/src/java/org/apache/nutch/parse/html/XMLCharacterRecognizer.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/plugin/parse-html/src/java/org/apache/nutch/parse/html/XMLCharacterRecognizer.java (original) +++ lucene/nutch/branches/Release-0.7/src/plugin/parse-html/src/java/org/apache/nutch/parse/html/XMLCharacterRecognizer.java Fri Aug 26 14:03:19 2005 @@ -27,7 +27,6 @@ /** * Class used to verify whether the specified <var>ch</var> * conforms to the XML 1.0 definition of whitespace. - * @xsl.usage internal */ public class XMLCharacterRecognizer { @@ -90,7 +89,7 @@ /** * Tell if the string is whitespace. * - * @param buf StringBuffer to check as XML whitespace. + * @param s String to check as XML whitespace. * @return True if characters in buffer are XML whitespace, false otherwise */ public static boolean isWhiteSpace(String s) Modified: lucene/nutch/branches/Release-0.7/src/plugin/protocol-httpclient/src/java/org/apache/nutch/protocol/httpclient/DummySSLProtocolSocketFactory.java URL: http://svn.apache.org/viewcvs/lucene/nutch/branches/Release-0.7/src/plugin/protocol-httpclient/src/java/org/apache/nutch/protocol/httpclient/DummySSLProtocolSocketFactory.java?rev=240345&r1=240344&r2=240345&view=diff ============================================================================== --- lucene/nutch/branches/Release-0.7/src/plugin/protocol-httpclient/src/java/org/apache/nutch/protocol/httpclient/DummySSLProtocolSocketFactory.java (original) +++ lucene/nutch/branches/Release-0.7/src/plugin/protocol-httpclient/src/java/org/apache/nutch/protocol/httpclient/DummySSLProtocolSocketFactory.java Fri Aug 26 14:03:19 2005 @@ -58,7 +58,7 @@ } /** - * @see SecureProtocolSocketFactory#createSocket(java.lang.String,int,java.net.InetAddress,int) + * @see org.apache.commons.httpclient.protocol.SecureProtocolSocketFactory#createSocket(String,int,InetAddress,int) */ public Socket createSocket(String host, int port, InetAddress clientHost, int clientPort) throws IOException, UnknownHostException { @@ -79,8 +79,8 @@ * * @param host the host name/IP * @param port the port on the host - * @param clientHost the local host name/IP to bind the socket to - * @param clientPort the port on the local machine + * @param localAddress the local host name/IP to bind the socket to + * @param localPort the port on the local machine * @param params [EMAIL PROTECTED] HttpConnectionParams Http connection parameters} * * @return Socket a new socket @@ -104,14 +104,14 @@ } /** - * @see SecureProtocolSocketFactory#createSocket(java.lang.String,int) + * @see org.apache.commons.httpclient.protocol.SecureProtocolSocketFactory#createSocket(String,int) */ public Socket createSocket(String host, int port) throws IOException, UnknownHostException { return getSSLContext().getSocketFactory().createSocket(host, port); } /** - * @see SecureProtocolSocketFactory#createSocket(java.net.Socket,java.lang.String,int,boolean) + * @see org.apache.commons.httpclient.protocol.SecureProtocolSocketFactory#createSocket(Socket,String,int,boolean) */ public Socket createSocket(Socket socket, String host, int port, boolean autoClose) throws IOException, UnknownHostException {