svn commit: r1227877 - /commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java

[sebb]

Author: sebb
Date: Thu Jan  5 22:34:18 2012
New Revision: 1227877

URL: http://svn.apache.org/viewvc?rev=1227877&view=rev
Log:
Javadoc

Modified:
    
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java

Modified: 
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
URL: 
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java?rev=1227877&r1=1227876&r2=1227877&view=diff
==============================================================================
--- 
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
 (original)
+++ 
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
 Thu Jan  5 22:34:18 2012
@@ -90,6 +90,7 @@ public class FTPListParseEngine {
      * on the server.
      *
      * @param stream input stream provided by the server socket.
+     * @param encoding the encoding to be used for reading the stream
      *
      * @exception IOException
      *                   thrown on any failure to read from the sever.
@@ -220,10 +221,10 @@ public class FTPListParseEngine {
      * @return an array of FTPFile objects containing the whole list of
      *         files returned by the server as read by this object's parser.
      * None of the entries will be null
-     * @exception IOException
+     * @exception IOException - not ever thrown, may be removed in a later 
release
      */
     public FTPFile[] getFiles()
-    throws IOException
+    throws IOException // TODO remove; not actually thrown
     {
         return getFiles(FTPFileFilters.NON_NULL);
     }
@@ -244,10 +245,10 @@ public class FTPListParseEngine {
      * a filter such as {@link FTPFileFilters#NON_NULL} which does not
      * allow null entries.
      * @since 2.2
-     * @exception IOException
+     * @exception IOException - not ever thrown, may be removed in a later 
release
      */
     public FTPFile[] getFiles(FTPFileFilter filter)
-    throws IOException
+    throws IOException // TODO remove; not actually thrown
     {
         List<FTPFile> tmpResults = new ArrayList<FTPFile>();
         Iterator<String> iter = this.entries.iterator();