From 584bc97d49f7491a9f900df36730ce162f87ba5c Mon Sep 17 00:00:00 2001
From: Sebastian Bazley <sebb@apache.org>
Date: Thu, 7 Apr 2011 21:57:30 +0000
Subject: [PATCH] Javadoc

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

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 872eac87a..032290e38 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
@@ -56,19 +56,16 @@ import org.apache.http.util.VersionInfo;
 /**
  * Default implementation of {@link HttpClient} pre-configured for most common use scenarios.
  * <p>
- * This class creates the following chain of protocol interceptors per default:
- * <ul>
- * <li>{@link RequestDefaultHeaders}</li>
- * <li>{@link RequestContent}</li>
- * <li>{@link RequestTargetHost}</li>
- * <li>{@link RequestClientConnControl}</li>
- * <li>{@link RequestUserAgent}</li>
- * <li>{@link RequestExpectContinue}</li>
- * <li>{@link RequestAddCookies}</li>
- * <li>{@link ResponseProcessCookies}</li>
- * <li>{@link RequestTargetAuthentication}</li>
- * <li>{@link RequestProxyAuthentication}</li>
- * </ul>
+ * Please see the Javadoc for {@link #createHttpProcessor()} for the details of the interceptors that are set up
+ * by default.
+ * <p>
+ * Additional interceptors can be added as follows, but
+ * take care not to add the same interceptor more than once.
+ * <pre>
+ * DefaultHttpClient httpclient = new DefaultHttpClient();
+ * httpclient.addRequestInterceptor(new RequestAcceptEncoding());
+ * httpclient.addResponseInterceptor(new ResponseContentEncoding());
+ * </pre>
  * <p>
  * This class sets up the following parameters if not explicitly set:
  * <ul>
@@ -189,7 +186,25 @@ public class DefaultHttpClient extends AbstractHttpClient {
                 "Apache-HttpClient/" + release + " (java 1.5)");
     }
 
-
+    /**
+    * Create the processor with the following interceptors:
+    * <ul>
+    * <li>{@link RequestDefaultHeaders}</li>
+    * <li>{@link RequestContent}</li>
+    * <li>{@link RequestTargetHost}</li>
+    * <li>{@link RequestClientConnControl}</li>
+    * <li>{@link RequestUserAgent}</li>
+    * <li>{@link RequestExpectContinue}</li>
+    * <li>{@link RequestAddCookies}</li>
+    * <li>{@link ResponseProcessCookies}</li>
+    * <li>{@link RequestAuthCache}</li>
+    * <li>{@link ResponseAuthCache}</li>
+    * <li>{@link RequestTargetAuthentication}</li>
+    * <li>{@link RequestProxyAuthentication}</li>
+    * </ul>
+    * <p>
+    * @return the processor with the added interceptors.
+    */
     @Override
     protected BasicHttpProcessor createHttpProcessor() {
         BasicHttpProcessor httpproc = new BasicHttpProcessor();