svn commit: r940214 - in /httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn: scheme/PlainSocketFactory.java scheme/SchemeSocketFactory.java ssl/SSLSocketFactory.java

[ol...@apache.org]

Author: olegk
Date: Sun May  2 13:20:07 2010
New Revision: 940214

URL: http://svn.apache.org/viewvc?rev=940214&view=rev
Log:
HTTPCLIENT-933: javadoc improvements

Modified:
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/PlainSocketFactory.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeSocketFactory.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ssl/SSLSocketFactory.java

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/PlainSocketFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/PlainSocketFactory.java?rev=940214&r1=940213&r2=940214&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/PlainSocketFactory.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/PlainSocketFactory.java Sun May  2 13:20:07 2010
@@ -85,6 +85,10 @@ public final class PlainSocketFactory im
     }
 
     /**
+     * @param params Optional parameters. Parameters passed to this method will have no effect.
+     *               This method will create a unconnected instance of {@link Socket} class
+     *               using default constructor.
+     * 
      * @since 4.1
      */
     public Socket createSocket(final HttpParams params) {

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeSocketFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeSocketFactory.java?rev=940214&r1=940213&r2=940214&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeSocketFactory.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/scheme/SchemeSocketFactory.java Sun May  2 13:20:07 2010
@@ -47,7 +47,14 @@ public interface SchemeSocketFactory {
      * Creates a new, unconnected socket. The socket should subsequently be passed to
      * {@link #connectSocket(Socket, InetSocketAddress, InetSocketAddress, HttpParams)}.
      *
-     * @param params    additional {@link HttpParams parameters}
+     * @param params    Optional {@link HttpParams parameters}. In most cases these parameters
+     *                  will not be required and will have no effect, as usually socket 
+     *                  initialization should take place in the 
+     *                  {@link #connectSocket(Socket, InetSocketAddress, InetSocketAddress, HttpParams)}
+     *                  method. However, in rare cases one may want to pass additional parameters
+     *                  to this method in order to create a customized {@link Socket} instance,
+     *                  for instance bound to a SOCKS proxy server.
+     *                  
      * @return  a new socket
      *
      * @throws IOException if an I/O error occurs while creating the socket

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ssl/SSLSocketFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ssl/SSLSocketFactory.java?rev=940214&r1=940213&r2=940214&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ssl/SSLSocketFactory.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ssl/SSLSocketFactory.java Sun May  2 13:20:07 2010
@@ -335,6 +335,9 @@ public class SSLSocketFactory implements
     }
 
     /**
+     * @param params Optional parameters. Parameters passed to this method will have no effect.
+     *               This method will create a unconnected instance of {@link Socket} class
+     *               using {@link javax.net.ssl.SSLSocketFactory#createSocket()} method.
      * @since 4.1
      */
     @SuppressWarnings("cast")