commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1586986 - in /commons/proper/net/trunk/src/main/java/org/apache/commons/net: ./ discard/ ftp/ ftp/parser/ nntp/ util/
Date Sun, 13 Apr 2014 13:58:27 GMT
Author: sebb
Date: Sun Apr 13 13:58:26 2014
New Revision: 1586986

URL: http://svn.apache.org/r1586986
Log:
Java 8 Javadoc fixes

Modified:
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/PrintCommandListener.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Base64.java

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/PrintCommandListener.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/PrintCommandListener.java?rev=1586986&r1=1586985&r2=1586986&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/PrintCommandListener.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/PrintCommandListener.java
Sun Apr 13 13:58:26 2014
@@ -134,7 +134,7 @@ public class PrintCommandListener implem
      * @param writer where to write the commands and responses
      * @param suppressLogin if {@code true}, only print command name for login
      * @param eolMarker if non-zero, add a marker just before the EOL.
-     * @param showDirection if {@code true}, add "> " or "< " as appropriate to the
output
+     * @param showDirection if {@code true}, add {@code ">} " or {@code "< "} as appropriate
to the output
      *
      * @since 3.0
      */

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java?rev=1586986&r1=1586985&r2=1586986&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java
Sun Apr 13 13:58:26 2014
@@ -31,7 +31,7 @@ import org.apache.commons.net.SocketClie
  * when you're done writing to it.  Rather, call
  * {@link org.apache.commons.net.SocketClient#disconnect  disconnect }
  * to clean up properly.
- * <p>
+ *
  * @see DiscardUDPClient
  ***/
 

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java?rev=1586986&r1=1586985&r2=1586986&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
Sun Apr 13 13:58:26 2014
@@ -67,7 +67,6 @@ import java.util.TreeMap;
  *    f.login(username, password);
  *    FTPFile[] files = listFiles(directory);
  * </pre>
- * </p>
  * <p>
  * Paged access on a UNIX server that uses Danish month names
  * and "European" date formatting in Denmark's time zone, when you
@@ -91,7 +90,6 @@ import java.util.TreeMap;
  *       //expensive FTPFile objects not created until needed.
  *    }
  * </pre>
- * </p>
  * <p>
  * Unpaged (whole list) access on a VMS server that uses month names
  * in a language not {@link #getSupportedLanguageCodes() supported} by the system.
@@ -106,7 +104,6 @@ import java.util.TreeMap;
  *    f.login(username, password);
  *    FTPFile[] files = listFiles(directory);
  * </pre>
- * </p>
  * <p>
  * Unpaged (whole list) access on a Windows-NT server in a different time zone.
  * (Note, since the NT Format uses numeric date formatting, language issues
@@ -120,7 +117,6 @@ import java.util.TreeMap;
  *    f.login(username, password);
  *    FTPFile[] files = listFiles(directory);
  * </pre>
- * </p>
  * Unpaged (whole list) access on a Windows-NT server in a different time zone
  * but which has been configured to use a unix-style listing format.
  * <pre>

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java?rev=1586986&r1=1586985&r2=1586986&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
Sun Apr 13 13:58:26 2014
@@ -89,7 +89,7 @@ import org.apache.commons.net.ftp.FTPFil
  *           systemTypeKey="OS/400"
  *           listing="ftp-listing.txt"
  *           &gt;
- *          &lt;fileset dir="./i5-downloads-file" casesensitive="false">
+ *          &lt;fileset dir="./i5-downloads-file" casesensitive="false"&gt;
  *              &lt;include name="run*.mbr" /&gt;
  *          &lt;/fileset&gt;
  *      &lt;/ftp&gt;
@@ -122,7 +122,7 @@ import org.apache.commons.net.ftp.FTPFil
  *           listing="ftp-listing.txt"
  *           &gt;
  *          &lt;fileset dir="./i5-downloads-lib" casesensitive="false"&gt;
- *              &lt;include name="**\run*.mbr" />
+ *              &lt;include name="**\run*.mbr" /&gt;
  *          &lt;/fileset&gt;
  *      &lt;/ftp&gt;
  *
@@ -143,8 +143,8 @@ import org.apache.commons.net.ftp.FTPFil
  * Example 3, using ANT to download specific members of a file:
  * ------------------------------------------------------------
  *
- *      &lt;echo/>
- *      &lt;echo>Downloading members of a file:</echo>
+ *      &lt;echo/&gt;
+ *      &lt;echo&gt;Downloading members of a file:&lt;/echo&gt;
  *
  *      &lt;ftp action="get"
  *           server="${ftp.server}"
@@ -154,11 +154,11 @@ import org.apache.commons.net.ftp.FTPFil
  *           verbose="true"
  *           remotedir="/QSYS.LIB/RPGUNIT.LIB/RPGUNITY1.FILE"
  *           systemTypeKey="OS/400"
- *           >
- *          &lt;fileset dir="./i5-downloads-file" casesensitive="false">
- *              &lt;include name="run*.mbr" />
- *          &lt;/fileset>
- *      &lt;/ftp>
+ *           &gt;
+ *          &lt;fileset dir="./i5-downloads-file" casesensitive="false"&gt;
+ *              &lt;include name="run*.mbr" /&gt;
+ *          &lt;/fileset&gt;
+ *      &lt;/ftp&gt;
  *
  * Output:
  * -------
@@ -174,8 +174,8 @@ import org.apache.commons.net.ftp.FTPFil
  * Example 4, using ANT to download specific members of all files of a library:
  * ----------------------------------------------------------------------------
  *
- *      &lt;echo/>
- *      &lt;echo>Downloading members of all files of a library:</echo>
+ *      &lt;echo/&gt;
+ *      &lt;echo&gt;Downloading members of all files of a library:&lt;/echo&gt;
  *
  *      &lt;ftp action="get"
  *           server="${ftp.server}"
@@ -185,11 +185,11 @@ import org.apache.commons.net.ftp.FTPFil
  *           verbose="true"
  *           remotedir="/QSYS.LIB/RPGUNIT.LIB"
  *           systemTypeKey="OS/400"
- *           >
- *          &lt;fileset dir="./i5-downloads-lib" casesensitive="false">
- *              &lt;include name="**\run*.mbr" />
- *          &lt;/fileset>
- *      &lt;/ftp>
+ *           &gt;
+ *          &lt;fileset dir="./i5-downloads-lib" casesensitive="false"&gt;
+ *              &lt;include name="**\run*.mbr" /&gt;
+ *          &lt;/fileset&gt;
+ *      &lt;/ftp&gt;
  *
  * Output:
  * -------
@@ -216,11 +216,11 @@ import org.apache.commons.net.ftp.FTPFil
  *           verbose="true"
  *           remotedir="/QSYS.LIB/RPGUNIT.LIB"
  *           systemTypeKey="OS/400"
- *           >
- *        &lt;fileset dir="./i5-downloads-savf" casesensitive="false">
- *            &lt;include name="RPGUNIT.SAVF" />
- *        &lt;/fileset>
- *      &lt;/ftp>
+ *           &gt;
+ *        &lt;fileset dir="./i5-downloads-savf" casesensitive="false"&gt;
+ *            &lt;include name="RPGUNIT.SAVF" /&gt;
+ *        &lt;/fileset&gt;
+ *      &lt;/ftp&gt;
  *
  * Output:
  * -------

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java?rev=1586986&r1=1586985&r2=1586986&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/RegexFTPFileEntryParserImpl.java
Sun Apr 13 13:58:26 2014
@@ -32,7 +32,7 @@ import org.apache.commons.net.ftp.FTPFil
  *
  * This is the base class for all regular expression based FTPFileEntryParser classes
  *
- * @author Steve Cohen <scohen@apache.org>
+ * @author Steve Cohen (scohen@apache.org)
  */
 public abstract class RegexFTPFileEntryParserImpl extends
         FTPFileEntryParserImpl {

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPClient.java?rev=1586986&r1=1586985&r2=1586986&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPClient.java Sun
Apr 13 13:58:26 2014
@@ -451,7 +451,7 @@ public class NNTPClient extends NNTP
     /***
      * Retrieves an article header from the NNTP server.  The article is
      * referenced
-     * by its unique article identifier (including the enclosing &lt; and &gt).
+     * by its unique article identifier (including the enclosing &lt; and &gt;).
      * The article number and identifier contained in the server reply
      * are returned through an ArticleInfo.  The <code> articleId </code>
      * field of the ArticleInfo cannot always be trusted because some
@@ -500,6 +500,7 @@ public class NNTPClient extends NNTP
      *  Note: the return can be cast to a {@link BufferedReader}
      * @param articleId the article id  to fetch
      * @return the reader
+     * @throws IOException if an error occurs
      */
     public Reader retrieveArticleHeader(String articleId) throws IOException
     {
@@ -509,6 +510,8 @@ public class NNTPClient extends NNTP
     /**
      * Same as <code> retrieveArticleHeader((String) null) </code>
      *  Note: the return can be cast to a {@link BufferedReader}
+     * @return the reader
+     * @throws IOException if an error occurs
      */
     public Reader retrieveArticleHeader() throws IOException
     {
@@ -562,7 +565,13 @@ public class NNTPClient extends NNTP
     }
 
 
-    /*** Same as <code> retrieveArticleHeader(articleNumber, null) </code> ***/
+    /**
+     * Same as <code> retrieveArticleHeader(articleNumber, null) </code> 
+     *
+     * @param articleNumber the article number
+     * @return the reader
+     * @throws IOException if an error occurs
+     */
     public BufferedReader retrieveArticleHeader(long articleNumber) throws IOException
     {
         return retrieveArticleHeader(articleNumber, null);
@@ -620,6 +629,9 @@ public class NNTPClient extends NNTP
     /**
      * Same as <code> retrieveArticleBody(articleId, (ArticleInfo) null) </code>
      *  Note: the return can be cast to a {@link BufferedReader}
+     * @param articleId the article id
+     * @return the reader
+     * @throws IOException if an error occurs
      */
     public Reader retrieveArticleBody(String articleId) throws IOException
     {
@@ -629,6 +641,8 @@ public class NNTPClient extends NNTP
     /**
      * Same as <code> retrieveArticleBody(null) </code>
      *  Note: the return can be cast to a {@link BufferedReader}
+     * @return the reader
+     * @throws IOException if an error occurs
      */
     public Reader retrieveArticleBody() throws IOException
     {
@@ -682,7 +696,12 @@ public class NNTPClient extends NNTP
     }
 
 
-    /*** Same as <code> retrieveArticleBody(articleNumber, null) </code> ***/
+    /**
+     * Same as <code> retrieveArticleBody(articleNumber, null) </code> 
+     * @param articleNumber the article number
+     * @return the reader
+     * @throws IOException if an error occurs
+     */
     public BufferedReader retrieveArticleBody(long articleNumber) throws IOException
     {
         return retrieveArticleBody(articleNumber, null);
@@ -721,7 +740,12 @@ public class NNTPClient extends NNTP
         return true;
     }
 
-    /*** Same as <code> selectNewsgroup(newsgroup, null) </code> ***/
+    /**
+     * Same as <code> selectNewsgroup(newsgroup, null) </code> 
+     * @param newsgroup the newsgroup name
+     * @return true if newsgroup exist and was selected
+     * @throws IOException if an error occurs
+     */
     public boolean selectNewsgroup(String newsgroup) throws IOException
     {
         return selectNewsgroup(newsgroup, null);

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Base64.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Base64.java?rev=1586986&r1=1586985&r2=1586986&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Base64.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Base64.java Sun Apr
13 13:58:26 2014
@@ -37,7 +37,6 @@ import java.math.BigInteger;
  * 4 in the encoded data.
  * <li>Line separator: Default is CRLF ("\r\n")</li>
  * </ul>
- * </p>
  * <p>
  * Since this class operates directly on byte streams, and not character streams, it is hard-coded
to only encode/decode
  * character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252,
UTF-8, etc).



Mime
View raw message