Javadoc fixes

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1055723 13f79535-47bb-0310-9956-ffa450edef68

httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java

@@ -145,8 +145,8 @@ public class HttpCacheEntry implements Serializable {
      * @param resource representing origin response body
      */
     public HttpCacheEntry(Date requestDate, Date responseDate, StatusLine statusLine,
-            Header[] headers, Resource resource) {
-        this(requestDate, responseDate, statusLine, headers, resource, null,
+            Header[] responseHeaders, Resource resource) {
+        this(requestDate, responseDate, statusLine, responseHeaders, resource, null,
                 new HashMap<String,String>());
     }
 
@@ -167,9 +167,9 @@ public class HttpCacheEntry implements Serializable {
      *   of this parent entry; each cache key should map to itself
      */
     public HttpCacheEntry(Date requestDate, Date responseDate,
-            StatusLine statusLine, Header[] headers,
+            StatusLine statusLine, Header[] responseHeaders,
             Resource resource, Map<String, String> variantMap) {
-        this(requestDate, responseDate, statusLine, headers,
+        this(requestDate, responseDate, statusLine, responseHeaders,
              resource, null, variantMap);
     }
 

httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheEntryUpdater.java

@@ -70,7 +70,7 @@ class CacheEntryUpdater {
      * Update the entry with the new information from the response.  Should only be used for
      * 304 responses.
      *
-     * @param request id
+     * @param requestId
      * @param entry The cache Entry to be updated
      * @param requestDate When the request was performed
      * @param responseDate When the response was gotten

httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheValidityPolicy.java

@@ -85,7 +85,7 @@ class CacheValidityPolicy {
      * @param now
      * @param coefficient
      * @param defaultLifetime
-     * @return
+     * @return {@code true} if the response is fresh
      */
     public boolean isResponseHeuristicallyFresh(final HttpCacheEntry entry,
             Date now, float coefficient, long defaultLifetime) {

httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CachedResponseSuitabilityChecker.java

@@ -214,7 +214,7 @@ class CachedResponseSuitabilityChecker {
     /**
      * Is this request the type of conditional request we support?
      * @param request
-     * @return
+     * @return {@code true} if the request is supported
      */
     public boolean isConditional(HttpRequest request) {
         return hasSupportedEtagVadlidator(request) || hasSupportedLastModifiedValidator(request);
@@ -225,7 +225,7 @@ class CachedResponseSuitabilityChecker {
      * @param request
      * @param entry
      * @param now
-     * @return
+     * @return {@code true} if the request matches all conditionals
      */
     public boolean allConditionalsMatch(HttpRequest request, HttpCacheEntry entry, Date now) {
         boolean hasEtagValidator = hasSupportedEtagVadlidator(request);

httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ConditionalRequestBuilder.java

@@ -93,7 +93,7 @@ class ConditionalRequestBuilder {
      * exist, the request is unmodified
      *
      * @param request the original request from the caller
-     * @param cacheEntry the entry that needs to be revalidated
+     * @param variants
      * @return the wrapped request
      */
     public HttpRequest buildConditionalRequestFromVariants(HttpRequest request,

httpclient-cache/src/main/java/org/apache/http/impl/client/cache/HttpCache.java

@@ -70,7 +70,7 @@ interface HttpCache {
      * Retrieve matching {@link HttpCacheEntry} from the cache if it exists
      * @param host
      * @param request
-     * @return
+     * @return the matching {@link HttpCacheEntry} or {@code null}
      * @throws IOException
      */
     HttpCacheEntry getCacheEntry(HttpHost host, HttpRequest request)
@@ -94,7 +94,7 @@ interface HttpCache {
      * @param originResponse
      * @param requestSent
      * @param responseReceived
-     * @return
+     * @return the {@link HttpResponse}
      * @throws IOException
      */
     HttpResponse cacheAndReturnResponse(
@@ -110,7 +110,7 @@ interface HttpCache {
      * @param originResponse
      * @param requestSent
      * @param responseReceived
-     * @return
+     * @return the updated {@link HttpCacheEntry}
      * @throws IOException
      */
     HttpCacheEntry updateCacheEntry(
@@ -128,7 +128,7 @@ interface HttpCache {
      * @param requestSent when the validating request was sent
      * @param responseReceived when the validating response was received
      * @param cacheKey where in the cache this entry is currently stored
-     * @return
+     * @return the updated {@link HttpCacheEntry}
      * @throws IOException
      */
     HttpCacheEntry updateVariantCacheEntry(HttpHost target, HttpRequest request,