You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by an...@apache.org on 2010/12/08 17:38:40 UTC

svn commit: r1043505 - in /ant/core/trunk/src/main/org/apache/tools: ant/taskdefs/ ant/types/mappers/ ant/types/resources/ zip/

Author: antoine
Date: Wed Dec  8 16:38:39 2010
New Revision: 1043505

URL: http://svn.apache.org/viewvc?rev=1043505&view=rev
Log:
fixing warnings in javadoc generation

Modified:
    ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java
    ant/core/trunk/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java
    ant/core/trunk/src/main/org/apache/tools/ant/types/resources/AbstractResourceCollectionWrapper.java
    ant/core/trunk/src/main/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.java
    ant/core/trunk/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java

Modified: ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java?rev=1043505&r1=1043504&r2=1043505&view=diff
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java Wed Dec  8 16:38:39 2010
@@ -264,7 +264,7 @@ public class PumpStreamHandler implement
      * @param is the input stream to copy from.
      * @param os the output stream to copy to.
      * @param closeWhenExhausted if true close the inputstream.
-     * @param useAvailable set it to <code>true</code> to use simulated non
+     * @param nonBlockingIO set it to <code>true</code> to use simulated non
      *                     blocking IO.
      * @return a thread object that does the pumping, subclasses
      * should return an instance of {@link ThreadWithPumper

Modified: ant/core/trunk/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java?rev=1043505&r1=1043504&r2=1043505&view=diff
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java Wed Dec  8 16:38:39 2010
@@ -28,7 +28,8 @@ import org.apache.tools.ant.util.FileNam
  * <p>This mapper was inspired by a user-list thread that mentioned
  * wget's --cut-dirs option.</p>
  *
- * @see http://mail-archives.apache.org/mod_mbox/ant-user/201009.mbox/%3C51772743BEA5D44A9EA5BF52AADDD6FB010E96F6@hammai008.delphi.local%3E
+ * @see <a href="http://mail-archives.apache.org/mod_mbox/ant-user/201009.mbox/%3C51772743BEA5D44A9EA5BF52AADDD6FB010E96F6@hammai008.delphi.local%3E">
+ * simplify copy with regexpmapper</a>
  */
 public class CutDirsMapper implements FileNameMapper {
     private int dirs = 0;

Modified: ant/core/trunk/src/main/org/apache/tools/ant/types/resources/AbstractResourceCollectionWrapper.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/types/resources/AbstractResourceCollectionWrapper.java?rev=1043505&r1=1043504&r2=1043505&view=diff
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/types/resources/AbstractResourceCollectionWrapper.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/types/resources/AbstractResourceCollectionWrapper.java Wed Dec  8 16:38:39 2010
@@ -119,7 +119,7 @@ public abstract class AbstractResourceCo
      * Do compute the size of the resource collection. The implementation of
      * this function is allowed to be not thread safe.
      * 
-     * @return
+     * @return size of resource collection.
      */
     protected abstract int getSize();
 

Modified: ant/core/trunk/src/main/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.java?rev=1043505&r1=1043504&r2=1043505&view=diff
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.java Wed Dec  8 16:38:39 2010
@@ -50,8 +50,8 @@ public class LazyResourceCollectionWrapp
      * Specify if the resource should be filtered or not. This function should
      * be overrided in order to define the filtering algorithm
      * 
-     * @param r
-     * @return
+     * @param r resource considered for filtration
+     * @return whether the resource should be filtered or not
      */
     protected boolean filterResource(Resource r) {
         return false;

Modified: ant/core/trunk/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java?rev=1043505&r1=1043504&r2=1043505&view=diff
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java (original)
+++ ant/core/trunk/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java Wed Dec  8 16:38:39 2010
@@ -22,9 +22,11 @@ package org.apache.tools.zip;
  * Wrapper for extra field data that doesn't conform to the recommended format of header-tag + size + data.
  *
  * <p>The header-id is artificial (and not listed as a know ID in
- * {@link http://www.pkware.com/documents/casestudies/APPNOTE.TXT
- * APPNOTE.TXT}.  Since it isn't used anywhere except to satisfy the
+ * the .ZIP File Format Specification).  
+ * Since it isn't used anywhere except to satisfy the
  * ZipExtraField contract it shouldn't matter anyway.</p>
+ * @see <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT
+ * APPNOTE.TXT">.ZIP File Format Specification</a>
  * @since Ant 1.8.1
  */
 public final class UnparseableExtraFieldData