More javadoc comments

Author: loopj

src/com/loopj/android/http/AsyncHttpResponseHandler.java

@@ -33,13 +33,38 @@
 
 /**
  * Used to intercept and handle the responses from requests made using 
- * {@link AsyncHttpClient}.
+ * {@link AsyncHttpClient}. The {@link #onSuccess(String)} method is 
+ * designed to be anonymously overridden with your own response handling code.
  * <p>
- * This class is designed to be passed to get, post, put and delete requests
- * with the {@link #onSuccess(String)} method anonymously overridden.
- * <p>
- * Optionally, you can also override the {@link #onFailure(Throwable)},
+ * Additionally, you can override the {@link #onFailure(Throwable)},
  * {@link #onStart()}, and {@link #onFinish()} methods as required.
+ * <p>
+ * For example:
+ * <p>
+ * <pre>
+ * AsyncHttpClient client = new AsyncHttpClient("My User Agent");
+ * client.get("http://www.google.com", new AsyncHttpResponseHandler() {
+ *     &#064;Override
+ *     public void onStart() {
+ *         // Initiated the request
+ *     }
+ *
+ *     &#064;Override
+ *     public void onSuccess(String response) {
+ *         // Successfully got a response
+ *     }
+ * 
+ *     &#064;Override
+ *     public void onFailure(Throwable e) {
+ *         // Response failed :(
+ *     }
+ *
+ *     &#064;Override
+ *     public void onFinish() {
+ *         // Completed the request (either success or failure)
+ *     }
+ * });
+ * </pre>
  */
 public class AsyncHttpResponseHandler {
     private static final int SUCCESS_MESSAGE = 0;

src/com/loopj/android/http/RequestParams.java

@@ -34,8 +34,23 @@
 import org.apache.http.message.BasicNameValuePair;
 
 /**
- * A collection of string request parameters or files to send along with HTTP
- * GET, POST or PUT requests made with {@link AsyncHttpClient}.
+ * A collection of string request parameters or files to send along with
+ * requests made from an {@link AsyncHttpClient} instance.
+ * <p>
+ * For example:
+ * <p>
+ * <pre>
+ * RequestParams params = new RequestParams();
+ * params.put("username", "james");
+ * params.put("password", "123456");
+ * params.put("email", "my&#064;email.com");
+ * params.put("profile_picture", new File("pic.jpg")); // Upload a File
+ * params.put("profile_picture2", someInputStream); // Upload an InputStream
+ * params.put("profile_picture3", new ByteArrayInputStream(someBytes)); // Upload some bytes
+ *
+ * AsyncHttpClient client = new AsyncHttpClient("My User Agent");
+ * client.post("http://myendpoint.com", params, responseHandler);
+ * </pre>
  */
 public class RequestParams {
     private static String ENCODING = "UTF-8";