From 967b8af955c92e4e234a389d079d65f68fab3d2d Mon Sep 17 00:00:00 2001
From: Sebastian Bazley <sebb@apache.org>
Date: Mon, 13 Dec 2010 11:35:35 +0000
Subject: [PATCH] Document initial parameter settings

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1045074 13f79535-47bb-0310-9956-ffa450edef68
---
 .../apache/http/impl/client/DefaultHttpClient.java  | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/httpclient/src/main/java/org/apache/http/impl/client/DefaultHttpClient.java b/httpclient/src/main/java/org/apache/http/impl/client/DefaultHttpClient.java
index e58751c7c..62d03e078 100644
--- a/httpclient/src/main/java/org/apache/http/impl/client/DefaultHttpClient.java
+++ b/httpclient/src/main/java/org/apache/http/impl/client/DefaultHttpClient.java
@@ -71,6 +71,8 @@ import org.apache.http.impl.cookie.IgnoreSpecFactory;
 import org.apache.http.impl.cookie.NetscapeDraftSpecFactory;
 import org.apache.http.impl.cookie.RFC2109SpecFactory;
 import org.apache.http.impl.cookie.RFC2965SpecFactory;
+import org.apache.http.params.CoreConnectionPNames;
+import org.apache.http.params.CoreProtocolPNames;
 import org.apache.http.params.HttpConnectionParams;
 import org.apache.http.params.HttpParams;
 import org.apache.http.params.HttpProtocolParams;
@@ -190,6 +192,17 @@ public class DefaultHttpClient extends AbstractHttpClient {
     }
 
 
+    /**
+     * Creates the default set of HttpParams.
+     * These are:
+     * <ul>
+     * <li>{@link CoreProtocolPNames#PROTOCOL_VERSION}: 1.1</li>
+     * <li>{@link CoreProtocolPNames#HTTP_CONTENT_CHARSET}: ISO-8859-1</li>
+     * <li>{@link CoreConnectionPNames#TCP_NODELAY}: true</li>
+     * <li>{@link CoreConnectionPNames#SOCKET_BUFFER_SIZE}: 8192</li>
+     * <li>{@link CoreProtocolPNames#USER_AGENT}: Apache-HttpClient/<release> (java 1.5)</li>
+     * </ul>
+     */
     @Override
     protected HttpParams createHttpParams() {
         HttpParams params = new SyncBasicHttpParams();