svn commit: r1652865 - in /commons/proper/net/trunk/src: main/java/examples/nntp/ main/java/examples/telnet/ main/java/org/apache/commons/net/ftp/parser/ test/java/org/apache/commons/net/ftp/parser/

[sebb]

Author: sebb
Date: Sun Jan 18 22:43:03 2015
New Revision: 1652865

URL: http://svn.apache.org/r1652865
Log:
Javadoc

Modified:
    commons/proper/net/trunk/src/main/java/examples/nntp/NNTPUtils.java
    
commons/proper/net/trunk/src/main/java/examples/telnet/TelnetClientExample.java
    
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
    
commons/proper/net/trunk/src/test/java/org/apache/commons/net/ftp/parser/FTPParseTestFramework.java

Modified: commons/proper/net/trunk/src/main/java/examples/nntp/NNTPUtils.java
URL: 
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/examples/nntp/NNTPUtils.java?rev=1652865&r1=1652864&r2=1652865&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/examples/nntp/NNTPUtils.java 
(original)
+++ commons/proper/net/trunk/src/main/java/examples/nntp/NNTPUtils.java Sun Jan 
18 22:43:03 2015
@@ -33,11 +33,11 @@ public class NNTPUtils {
     /**
      * Given an {@link NNTPClient} instance, and an integer range of messages, 
return
      * an array of {@link Article} instances.
-     * @param client
-     * @param lowArticleNumber
-     * @param highArticleNumber
+     * @param client the client to use
+     * @param lowArticleNumber low number
+     * @param highArticleNumber high number
      * @return Article[] An array of Article
-     * @throws IOException
+     * @throws IOException on error
      */
     public  static List<Article> getArticleInfo(NNTPClient client, long 
lowArticleNumber, long highArticleNumber)
     throws IOException {

Modified: 
commons/proper/net/trunk/src/main/java/examples/telnet/TelnetClientExample.java
URL: 
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/examples/telnet/TelnetClientExample.java?rev=1652865&r1=1652864&r2=1652865&view=diff
==============================================================================
--- 
commons/proper/net/trunk/src/main/java/examples/telnet/TelnetClientExample.java 
(original)
+++ 
commons/proper/net/trunk/src/main/java/examples/telnet/TelnetClientExample.java 
Sun Jan 18 22:43:03 2015
@@ -53,6 +53,8 @@ public class TelnetClientExample impleme
 
     /***
      * Main for the TelnetClientExample.
+     * @param args input params
+     * @throws Exception on error
      ***/
     public static void main(String[] args) throws Exception
     {

Modified: 
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
URL: 
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java?rev=1652865&r1=1652864&r2=1652865&view=diff
==============================================================================
--- 
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
 (original)
+++ 
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
 Sun Jan 18 22:43:03 2015
@@ -86,7 +86,7 @@ public class UnixFTPEntryParser extends
      *    +   file has extended security attributes (e.g. ACL)
      *    Note: local listings on MacOSX also use '@'; 
      *    this is not allowed for here as does not appear to be shown by FTP 
servers
-     *    @   file has extended attributes
+     *    {@code @}   file has extended attributes
      */
     private static final String REGEX =
         "([bcdelfmpSs-])" // file type

Modified: 
commons/proper/net/trunk/src/test/java/org/apache/commons/net/ftp/parser/FTPParseTestFramework.java
URL: 
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/test/java/org/apache/commons/net/ftp/parser/FTPParseTestFramework.java?rev=1652865&r1=1652864&r2=1652865&view=diff
==============================================================================
--- 
commons/proper/net/trunk/src/test/java/org/apache/commons/net/ftp/parser/FTPParseTestFramework.java
 (original)
+++ 
commons/proper/net/trunk/src/test/java/org/apache/commons/net/ftp/parser/FTPParseTestFramework.java
 Sun Jan 18 22:43:03 2015
@@ -113,14 +113,14 @@ public abstract class FTPParseTestFramew
     /**
      * Method testParseFieldsOnDirectory.
      * Provide a test to show that fields on a directory entry are parsed 
correctly.
-     * @throws Exception
+     * @throws Exception on error
      */
     public abstract void testParseFieldsOnDirectory() throws Exception;
 
     /**
      * Method testParseFieldsOnFile.
      * Provide a test to show that fields on a file entry are parsed correctly.
-     * @throws Exception
+     * @throws Exception on error
      */
     public abstract void testParseFieldsOnFile() throws Exception;