From c76412a8390431e8a5fb8aee4fb363d587e534dd Mon Sep 17 00:00:00 2001 From: "Gary D. Gregory" Date: Thu, 21 Aug 2014 14:19:59 +0000 Subject: [PATCH] Javadoc 8 fixes. git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1619405 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/http/client/RequestDirector.java | 5 +++-- .../java/org/apache/http/client/UserTokenHandler.java | 2 +- .../main/java/org/apache/http/client/methods/HttpGet.java | 2 +- .../java/org/apache/http/client/methods/HttpHead.java | 2 +- .../java/org/apache/http/client/methods/HttpOptions.java | 2 +- .../java/org/apache/http/client/methods/HttpPatch.java | 8 +++++--- .../java/org/apache/http/client/methods/HttpPost.java | 2 +- .../main/java/org/apache/http/client/methods/HttpPut.java | 2 +- .../java/org/apache/http/client/methods/HttpTrace.java | 2 +- .../org/apache/http/client/methods/HttpUriRequest.java | 3 ++- .../org/apache/http/client/params/AllClientPNames.java | 3 ++- 11 files changed, 19 insertions(+), 14 deletions(-) diff --git a/httpclient/src/main/java-deprecated/org/apache/http/client/RequestDirector.java b/httpclient/src/main/java-deprecated/org/apache/http/client/RequestDirector.java index 195c1e60b..f4cb46237 100644 --- a/httpclient/src/main/java-deprecated/org/apache/http/client/RequestDirector.java +++ b/httpclient/src/main/java-deprecated/org/apache/http/client/RequestDirector.java @@ -52,10 +52,11 @@ public interface RequestDirector { /** * Executes a request. - *
Note: - * For the time being, a new director is instantiated for each request. + *

+ * Note: For the time being, a new director is instantiated for each request. * This is the same behavior as for HttpMethodDirector * in HttpClient 3. + *

* * @param target the target host for the request. * Implementations may accept null diff --git a/httpclient/src/main/java/org/apache/http/client/UserTokenHandler.java b/httpclient/src/main/java/org/apache/http/client/UserTokenHandler.java index efddb164c..d1951e3ed 100644 --- a/httpclient/src/main/java/org/apache/http/client/UserTokenHandler.java +++ b/httpclient/src/main/java/org/apache/http/client/UserTokenHandler.java @@ -52,7 +52,7 @@ public interface UserTokenHandler { * @param context the execution context * * @return user token that uniquely identifies the user or - * null if the context is not user specific. + * {@code null} if the context is not user specific. */ Object getUserToken(HttpContext context); diff --git a/httpclient/src/main/java/org/apache/http/client/methods/HttpGet.java b/httpclient/src/main/java/org/apache/http/client/methods/HttpGet.java index 674b2ee01..35de2d3e4 100644 --- a/httpclient/src/main/java/org/apache/http/client/methods/HttpGet.java +++ b/httpclient/src/main/java/org/apache/http/client/methods/HttpGet.java @@ -36,6 +36,7 @@ import org.apache.http.annotation.NotThreadSafe; *

* The HTTP GET method is defined in section 9.3 of * RFC2616: + *

*
* The GET method means retrieve whatever information (in the form of an * entity) is identified by the Request-URI. If the Request-URI refers @@ -43,7 +44,6 @@ import org.apache.http.annotation.NotThreadSafe; * returned as the entity in the response and not the source text of the * process, unless that text happens to be the output of the process. *
- *

* * @since 4.0 */ diff --git a/httpclient/src/main/java/org/apache/http/client/methods/HttpHead.java b/httpclient/src/main/java/org/apache/http/client/methods/HttpHead.java index 6fb1edf33..4e4bd9667 100644 --- a/httpclient/src/main/java/org/apache/http/client/methods/HttpHead.java +++ b/httpclient/src/main/java/org/apache/http/client/methods/HttpHead.java @@ -36,6 +36,7 @@ import org.apache.http.annotation.NotThreadSafe; *

* The HTTP HEAD method is defined in section 9.4 of * RFC2616: + *

*
* The HEAD method is identical to GET except that the server MUST NOT * return a message-body in the response. The metainformation contained @@ -46,7 +47,6 @@ import org.apache.http.annotation.NotThreadSafe; * often used for testing hypertext links for validity, accessibility, * and recent modification. *
- *

* * @since 4.0 */ diff --git a/httpclient/src/main/java/org/apache/http/client/methods/HttpOptions.java b/httpclient/src/main/java/org/apache/http/client/methods/HttpOptions.java index 614dddf3e..382eddac4 100644 --- a/httpclient/src/main/java/org/apache/http/client/methods/HttpOptions.java +++ b/httpclient/src/main/java/org/apache/http/client/methods/HttpOptions.java @@ -43,6 +43,7 @@ import org.apache.http.util.Args; *

* The HTTP OPTIONS method is defined in section 9.2 of * RFC2616: + *

*
* The OPTIONS method represents a request for information about the * communication options available on the request/response chain @@ -51,7 +52,6 @@ import org.apache.http.util.Args; * or the capabilities of a server, without implying a resource action * or initiating a resource retrieval. *
- *

* * @since 4.0 */ diff --git a/httpclient/src/main/java/org/apache/http/client/methods/HttpPatch.java b/httpclient/src/main/java/org/apache/http/client/methods/HttpPatch.java index 3a6b126e6..f96fe5adb 100644 --- a/httpclient/src/main/java/org/apache/http/client/methods/HttpPatch.java +++ b/httpclient/src/main/java/org/apache/http/client/methods/HttpPatch.java @@ -35,7 +35,9 @@ import org.apache.http.annotation.NotThreadSafe; * HTTP PATCH method. *

* The HTTP PATCH method is defined in RF5789:

The PATCH + * href="http://tools.ietf.org/html/rfc5789">RF5789: + *

+ *
The PATCH * method requests that a set of changes described in the request entity be * applied to the resource identified by the Request- URI. Differs from the PUT * method in the way the server processes the enclosed entity to modify the @@ -43,8 +45,8 @@ import org.apache.http.annotation.NotThreadSafe; * origin server, and the client is requesting that the stored version be * replaced. With PATCH, however, the enclosed entity contains a set of * instructions describing how a resource currently residing on the origin - * server should be modified to produce a new version.
- *

+ * server should be modified to produce a new version. + *
* * @since 4.2 */ diff --git a/httpclient/src/main/java/org/apache/http/client/methods/HttpPost.java b/httpclient/src/main/java/org/apache/http/client/methods/HttpPost.java index 099833d67..410092e0d 100644 --- a/httpclient/src/main/java/org/apache/http/client/methods/HttpPost.java +++ b/httpclient/src/main/java/org/apache/http/client/methods/HttpPost.java @@ -36,6 +36,7 @@ import org.apache.http.annotation.NotThreadSafe; *

* The HTTP POST method is defined in section 9.5 of * RFC2616: + *

*
* The POST method is used to request that the origin server accept the entity * enclosed in the request as a new subordinate of the resource identified by @@ -50,7 +51,6 @@ import org.apache.http.annotation.NotThreadSafe; *
  • Extending a database through an append operation
    • * *
    - *

    * * @since 4.0 */ diff --git a/httpclient/src/main/java/org/apache/http/client/methods/HttpPut.java b/httpclient/src/main/java/org/apache/http/client/methods/HttpPut.java index aadd14505..ac0515a64 100644 --- a/httpclient/src/main/java/org/apache/http/client/methods/HttpPut.java +++ b/httpclient/src/main/java/org/apache/http/client/methods/HttpPut.java @@ -36,13 +36,13 @@ import org.apache.http.annotation.NotThreadSafe; *

    * The HTTP PUT method is defined in section 9.6 of * RFC2616: + *

    *
    * The PUT method requests that the enclosed entity be stored under the * supplied Request-URI. If the Request-URI refers to an already * existing resource, the enclosed entity SHOULD be considered as a * modified version of the one residing on the origin server. *
    - *

    * * @since 4.0 */ diff --git a/httpclient/src/main/java/org/apache/http/client/methods/HttpTrace.java b/httpclient/src/main/java/org/apache/http/client/methods/HttpTrace.java index 6b16e0d4a..c0bcc8616 100644 --- a/httpclient/src/main/java/org/apache/http/client/methods/HttpTrace.java +++ b/httpclient/src/main/java/org/apache/http/client/methods/HttpTrace.java @@ -36,6 +36,7 @@ import org.apache.http.annotation.NotThreadSafe; *

    * The HTTP TRACE method is defined in section 9.6 of * RFC2616: + *

    *
    * The TRACE method is used to invoke a remote, application-layer loop- * back of the request message. The final recipient of the request @@ -45,7 +46,6 @@ import org.apache.http.annotation.NotThreadSafe; * value of zero (0) in the request (see section 14.31). A TRACE request * MUST NOT include an entity. *
    - *

    * * @since 4.0 */ diff --git a/httpclient/src/main/java/org/apache/http/client/methods/HttpUriRequest.java b/httpclient/src/main/java/org/apache/http/client/methods/HttpUriRequest.java index 8d8510f44..ae258edb1 100644 --- a/httpclient/src/main/java/org/apache/http/client/methods/HttpUriRequest.java +++ b/httpclient/src/main/java/org/apache/http/client/methods/HttpUriRequest.java @@ -49,8 +49,9 @@ public interface HttpUriRequest extends HttpRequest { /** * Returns the URI this request uses, such as * http://example.org/path/to/file. - *
    + *

    * Note that the URI may be absolute URI (as above) or may be a relative URI. + *

    *

    * Implementations are encouraged to return * the URI that was initially requested. diff --git a/httpclient/src/main/java/org/apache/http/client/params/AllClientPNames.java b/httpclient/src/main/java/org/apache/http/client/params/AllClientPNames.java index d11fe0955..bd4502835 100644 --- a/httpclient/src/main/java/org/apache/http/client/params/AllClientPNames.java +++ b/httpclient/src/main/java/org/apache/http/client/params/AllClientPNames.java @@ -40,10 +40,11 @@ import org.apache.http.params.CoreProtocolPNames; * module and all dependency modules or informational units. * It does not define additional parameter names, but references * other interfaces defining parameter names. - *
    + *

    * This interface is meant as a navigation aid for developers. * When referring to parameter names, you should use the interfaces * in which the respective constants are actually defined. + *

    * * @since 4.0 *