Author: mattmann
Date: Mon Jan 29 21:55:03 2007
New Revision: 501315

URL: http://svn.apache.org/viewvc?view=rev&rev=501315
Log:
Fix for NUTCH-390 Javadoc warnings

Modified:
    lucene/nutch/trunk/CHANGES.txt
    lucene/nutch/trunk/lib/commons-logging-1.0.4.jar
    lucene/nutch/trunk/src/java/org/apache/nutch/net/URLNormalizers.java
    
lucene/nutch/trunk/src/java/org/apache/nutch/plugin/PluginManifestParser.java
    lucene/nutch/trunk/src/java/org/apache/nutch/protocol/ProtocolFactory.java
    lucene/nutch/trunk/src/java/org/apache/nutch/scoring/ScoringFilter.java
    lucene/nutch/trunk/src/java/org/apache/nutch/segment/SegmentPart.java
    lucene/nutch/trunk/src/java/org/apache/nutch/util/DomUtil.java
    lucene/nutch/trunk/src/plugin/ontology/lib/commons-logging-1.0.3.jar

Modified: lucene/nutch/trunk/CHANGES.txt
URL: 
http://svn.apache.org/viewvc/lucene/nutch/trunk/CHANGES.txt?view=diff&rev=501315&r1=501314&r2=501315
==============================================================================
--- lucene/nutch/trunk/CHANGES.txt (original)
+++ lucene/nutch/trunk/CHANGES.txt Mon Jan 29 21:55:03 2007
@@ -144,6 +144,8 @@
 
 47. NUTCH-339 - Fetcher2: a queue-based fetcher implementation. (ab)
 
+48. NUTCH-390 - Javadoc warnings (mattmann)
+
 
 Release 0.8 - 2006-07-25
 

Modified: lucene/nutch/trunk/lib/commons-logging-1.0.4.jar
URL: 
http://svn.apache.org/viewvc/lucene/nutch/trunk/lib/commons-logging-1.0.4.jar?view=diff&rev=501315&r1=501314&r2=501315
==============================================================================
Binary files - no diff available.

Modified: lucene/nutch/trunk/src/java/org/apache/nutch/net/URLNormalizers.java
URL: 
http://svn.apache.org/viewvc/lucene/nutch/trunk/src/java/org/apache/nutch/net/URLNormalizers.java?view=diff&rev=501315&r1=501314&r2=501315
==============================================================================
--- lucene/nutch/trunk/src/java/org/apache/nutch/net/URLNormalizers.java 
(original)
+++ lucene/nutch/trunk/src/java/org/apache/nutch/net/URLNormalizers.java Mon 
Jan 29 21:55:03 2007
@@ -55,7 +55,7 @@
  * "urlnormalizer.order.<scope_name>" property). If any of these properties are
  * missing, default settings are used for the global scope.</p>
  * <p>In case no normalizers are required for any given scope, a
- * [EMAIL PROTECTED] 
org.apache.nutch.net.urlnormalizer.pass.PassURLNormalizer} should be used.</p>
+ * <code>org.apache.nutch.net.urlnormalizer.pass.PassURLNormalizer</code> 
should be used.</p>
  * <p>Each normalizer may further select among many configurations, depending 
on
  * the scope in which it is called, because the scope name is passed as a 
parameter
  * to each normalizer. You can also use the same normalizer for many 
scopes.</p>
@@ -266,10 +266,10 @@
 
   /**
    * Normalize
-   * @param urlString
-   * @param scope
-   * @return
-   * @throws MalformedURLException
+   * @param urlString The URL string to normalize.
+   * @param scope The given scope.
+   * @return A normalized String, using the given <code>scope</code>
+   * @throws MalformedURLException If the given URL string is malformed.
    */
   public String normalize(String urlString, String scope)
           throws MalformedURLException {

Modified: 
lucene/nutch/trunk/src/java/org/apache/nutch/plugin/PluginManifestParser.java
URL: 
http://svn.apache.org/viewvc/lucene/nutch/trunk/src/java/org/apache/nutch/plugin/PluginManifestParser.java?view=diff&rev=501315&r1=501314&r2=501315
==============================================================================
--- 
lucene/nutch/trunk/src/java/org/apache/nutch/plugin/PluginManifestParser.java 
(original)
+++ 
lucene/nutch/trunk/src/java/org/apache/nutch/plugin/PluginManifestParser.java 
Mon Jan 29 21:55:03 2007
@@ -69,7 +69,7 @@
    * 
    * @param pluginFolders
    *          folders to search plugins from
-   * @return
+   * @return A [EMAIL PROTECTED] Map} of all found [EMAIL PROTECTED] 
PluginDescriptor}s.
    */
   public Map<String, PluginDescriptor> parsePluginFolder(String[] 
pluginFolders) {
     Map<String, PluginDescriptor> map = new HashMap<String, 
PluginDescriptor>();

Modified: 
lucene/nutch/trunk/src/java/org/apache/nutch/protocol/ProtocolFactory.java
URL: 
http://svn.apache.org/viewvc/lucene/nutch/trunk/src/java/org/apache/nutch/protocol/ProtocolFactory.java?view=diff&rev=501315&r1=501314&r2=501315
==============================================================================
--- lucene/nutch/trunk/src/java/org/apache/nutch/protocol/ProtocolFactory.java 
(original)
+++ lucene/nutch/trunk/src/java/org/apache/nutch/protocol/ProtocolFactory.java 
Mon Jan 29 21:55:03 2007
@@ -33,7 +33,7 @@
  * the attribute "protocolName" with the name of the protocol that they
  * implement. Configuration object is used for caching. Cache key is 
constructed
  * from appending protocol name (eg. http) to constant
- * [EMAIL PROTECTED] Protocol#X_POINT_ID).
+ * [EMAIL PROTECTED] Protocol#X_POINT_ID}.
  */
 public class ProtocolFactory {
 
@@ -58,7 +58,7 @@
    * 
    * @param urlString
    *          Url String
-   * @return
+   * @return The appropriate [EMAIL PROTECTED] Protocol} implementation for a 
given [EMAIL PROTECTED] URL}.
    * @throws ProtocolNotFound
    *           when Protocol can not be found for urlString
    */

Modified: 
lucene/nutch/trunk/src/java/org/apache/nutch/scoring/ScoringFilter.java
URL: 
http://svn.apache.org/viewvc/lucene/nutch/trunk/src/java/org/apache/nutch/scoring/ScoringFilter.java?view=diff&rev=501315&r1=501314&r2=501315
==============================================================================
--- lucene/nutch/trunk/src/java/org/apache/nutch/scoring/ScoringFilter.java 
(original)
+++ lucene/nutch/trunk/src/java/org/apache/nutch/scoring/ScoringFilter.java Mon 
Jan 29 21:55:03 2007
@@ -128,7 +128,7 @@
    * @param url url of the page
    * @param old original datum, with original score. May be null if this is a 
newly
    * discovered page. If not null, filters should use score values from this 
parameter
-   * as the starting values - the [EMAIL PROTECTED] datum} parameter may 
contain values that are
+   * as the starting values - the <code>datum</code> parameter may contain 
values that are
    * no longer valid, if other updates occured between generation and this 
update.
    * @param datum the new datum, with the original score saved at the time when
    * fetchlist was generated. Filters should update this in-place, and it will 
be saved in

Modified: lucene/nutch/trunk/src/java/org/apache/nutch/segment/SegmentPart.java
URL: 
http://svn.apache.org/viewvc/lucene/nutch/trunk/src/java/org/apache/nutch/segment/SegmentPart.java?view=diff&rev=501315&r1=501314&r2=501315
==============================================================================
--- lucene/nutch/trunk/src/java/org/apache/nutch/segment/SegmentPart.java 
(original)
+++ lucene/nutch/trunk/src/java/org/apache/nutch/segment/SegmentPart.java Mon 
Jan 29 21:55:03 2007
@@ -52,7 +52,8 @@
   /**
    * Create SegmentPart from a FileSplit.
    * @param split
-   * @return
+   * @return A [EMAIL PROTECTED] SegmentPart} resultant from a 
+   * [EMAIL PROTECTED] FileSplit}.
    * @throws Exception
    */
   public static SegmentPart get(FileSplit split) throws IOException {

Modified: lucene/nutch/trunk/src/java/org/apache/nutch/util/DomUtil.java
URL: 
http://svn.apache.org/viewvc/lucene/nutch/trunk/src/java/org/apache/nutch/util/DomUtil.java?view=diff&rev=501315&r1=501314&r2=501315
==============================================================================
--- lucene/nutch/trunk/src/java/org/apache/nutch/util/DomUtil.java (original)
+++ lucene/nutch/trunk/src/java/org/apache/nutch/util/DomUtil.java Mon Jan 29 
21:55:03 2007
@@ -47,7 +47,7 @@
    * Returns parsed dom tree or null if any error
    * 
    * @param is
-   * @return
+   * @return A parsed DOM tree from the given [EMAIL PROTECTED] InputStream}.
    */
   public static Element getDom(InputStream is) {
 

Modified: lucene/nutch/trunk/src/plugin/ontology/lib/commons-logging-1.0.3.jar
URL: 
http://svn.apache.org/viewvc/lucene/nutch/trunk/src/plugin/ontology/lib/commons-logging-1.0.3.jar?view=diff&rev=501315&r1=501314&r2=501315
==============================================================================
Binary files - no diff available.


Reply via email to