You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by gg...@apache.org on 2014/07/20 15:42:20 UTC
svn commit: r1612086 - in /httpcomponents/httpclient/trunk/httpclient/src:
main/java/org/apache/http/auth/ main/java/org/apache/http/client/
main/java/org/apache/http/client/protocol/
main/java/org/apache/http/cookie/ main/java/org/apache/http/impl/aut...
Author: ggregory
Date: Sun Jul 20 13:42:19 2014
New Revision: 1612086
URL: http://svn.apache.org/r1612086
Log:
Javadoc fixes.
Modified:
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScope.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthenticationException.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/InvalidCredentialsException.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/MalformedChallengeException.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/CircularRedirectException.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/RedirectException.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ResponseContentEncoding.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/CookieAttributeHandler.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/MalformedCookieException.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/SetCookie2.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMEngineException.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/UnsupportedDigestAlgorithmException.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/DefaultRedirectStrategy.java
httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/impl/cookie/TestCookieRFC2965Spec.java
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java Sun Jul 20 13:42:19 2014
@@ -95,7 +95,7 @@ public interface AuthScheme {
* Tests if the authentication scheme is provides authorization on a per
* connection basis instead of usual per request basis
*
- * @return {@code true</tt> if the scheme is connection based, <tt>false}
+ * @return {@code true} if the scheme is connection based, {@code false}
* if the scheme is request based.
*/
boolean isConnectionBased();
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScope.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScope.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScope.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScope.java Sun Jul 20 13:42:19 2014
@@ -89,7 +89,7 @@ public class AuthScope {
private final HttpHost origin;
/**
- * Defines auth scope with the given {@code host</tt>, <tt>port</tt>, <tt>realm}, and
+ * Defines auth scope with the given {@code host}, {@code port}, {@code realm}, and
* {@code authentication scheme}.
*
* @param host authentication host. May be {@link #ANY_HOST} if applies
@@ -148,7 +148,7 @@ public class AuthScope {
}
/**
- * Defines auth scope with the given {@code host</tt>, <tt>port</tt> and <tt>realm}.
+ * Defines auth scope with the given {@code host}, {@code port} and {@code realm}.
*
* @param host authentication host. May be {@link #ANY_HOST} if applies
* to any host.
@@ -162,7 +162,7 @@ public class AuthScope {
}
/**
- * Defines auth scope with the given {@code host</tt> and <tt>port}.
+ * Defines auth scope with the given {@code host} and {@code port}.
*
* @param host authentication host. May be {@link #ANY_HOST} if applies
* to any host.
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthenticationException.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthenticationException.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthenticationException.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthenticationException.java Sun Jul 20 13:42:19 2014
@@ -60,7 +60,7 @@ public class AuthenticationException ext
* Creates a new AuthenticationException with the specified detail message and cause.
*
* @param message the exception detail message
- * @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
+ * @param cause the {@code Throwable} that caused this exception, or {@code null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public AuthenticationException(final String message, final Throwable cause) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/InvalidCredentialsException.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/InvalidCredentialsException.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/InvalidCredentialsException.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/InvalidCredentialsException.java Sun Jul 20 13:42:19 2014
@@ -60,7 +60,7 @@ public class InvalidCredentialsException
* Creates a new InvalidCredentialsException with the specified detail message and cause.
*
* @param message the exception detail message
- * @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
+ * @param cause the {@code Throwable} that caused this exception, or {@code null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public InvalidCredentialsException(final String message, final Throwable cause) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/MalformedChallengeException.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/MalformedChallengeException.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/MalformedChallengeException.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/MalformedChallengeException.java Sun Jul 20 13:42:19 2014
@@ -61,7 +61,7 @@ public class MalformedChallengeException
* Creates a new MalformedChallengeException with the specified detail message and cause.
*
* @param message the exception detail message
- * @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
+ * @param cause the {@code Throwable} that caused this exception, or {@code null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public MalformedChallengeException(final String message, final Throwable cause) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/CircularRedirectException.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/CircularRedirectException.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/CircularRedirectException.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/CircularRedirectException.java Sun Jul 20 13:42:19 2014
@@ -59,7 +59,7 @@ public class CircularRedirectException e
* Creates a new CircularRedirectException with the specified detail message and cause.
*
* @param message the exception detail message
- * @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
+ * @param cause the {@code Throwable} that caused this exception, or {@code null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public CircularRedirectException(final String message, final Throwable cause) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/RedirectException.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/RedirectException.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/RedirectException.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/RedirectException.java Sun Jul 20 13:42:19 2014
@@ -60,7 +60,7 @@ public class RedirectException extends P
* Creates a new RedirectException with the specified detail message and cause.
*
* @param message the exception detail message
- * @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
+ * @param cause the {@code Throwable} that caused this exception, or {@code null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public RedirectException(final String message, final Throwable cause) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ResponseContentEncoding.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ResponseContentEncoding.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ResponseContentEncoding.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ResponseContentEncoding.java Sun Jul 20 13:42:19 2014
@@ -92,7 +92,7 @@ public class ResponseContentEncoding imp
}
/**
- * Handles {@code gzip</tt> and <tt>deflate} compressed entities by using the following
+ * Handles {@code gzip} and {@code deflate} compressed entities by using the following
* decoders:
* <ul>
* <li>gzip - see {@link GZIPInputStream}</li>
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/CookieAttributeHandler.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/CookieAttributeHandler.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/CookieAttributeHandler.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/CookieAttributeHandler.java Sun Jul 20 13:42:19 2014
@@ -66,7 +66,7 @@ public interface CookieAttributeHandler
*
* @param cookie {@link org.apache.http.cookie.Cookie} to match
* @param origin the cookie source to match against
- * @return {@code true</tt> if the match is successful; <tt>false} otherwise
+ * @return {@code true} if the match is successful; {@code false} otherwise
*/
boolean match(Cookie cookie, CookieOrigin origin);
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/MalformedCookieException.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/MalformedCookieException.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/MalformedCookieException.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/MalformedCookieException.java Sun Jul 20 13:42:19 2014
@@ -62,7 +62,7 @@ public class MalformedCookieException ex
* Creates a new MalformedCookieException with the specified detail message and cause.
*
* @param message the exception detail message
- * @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
+ * @param cause the {@code Throwable} that caused this exception, or {@code null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public MalformedCookieException(final String message, final Throwable cause) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/SetCookie2.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/SetCookie2.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/SetCookie2.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/SetCookie2.java Sun Jul 20 13:42:19 2014
@@ -50,7 +50,7 @@ public interface SetCookie2 extends SetC
/**
* Set the Discard attribute.
*
- * Note: {@code Discard</tt> attribute overrides <tt>Max-age}.
+ * Note: {@code Discard} attribute overrides {@code Max-age}.
*
* @see #isPersistent()
*/
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMEngineException.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMEngineException.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMEngineException.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMEngineException.java Sun Jul 20 13:42:19 2014
@@ -57,7 +57,7 @@ public class NTLMEngineException extends
* Creates a new NTLMEngineException with the specified detail message and cause.
*
* @param message the exception detail message
- * @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
+ * @param cause the {@code Throwable} that caused this exception, or {@code null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public NTLMEngineException(final String message, final Throwable cause) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/UnsupportedDigestAlgorithmException.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/UnsupportedDigestAlgorithmException.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/UnsupportedDigestAlgorithmException.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/UnsupportedDigestAlgorithmException.java Sun Jul 20 13:42:19 2014
@@ -60,7 +60,7 @@ public class UnsupportedDigestAlgorithmE
* Creates a new UnsupportedAuthAlgoritmException with the specified detail message and cause.
*
* @param message the exception detail message
- * @param cause the {@code Throwable</tt> that caused this exception, or <tt>null}
+ * @param cause the {@code Throwable} that caused this exception, or {@code null}
* if the cause is unavailable, unknown, or not a {@code Throwable}
*/
public UnsupportedDigestAlgorithmException(final String message, final Throwable cause) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/DefaultRedirectStrategy.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/DefaultRedirectStrategy.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/DefaultRedirectStrategy.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/DefaultRedirectStrategy.java Sun Jul 20 13:42:19 2014
@@ -58,7 +58,7 @@ import org.apache.http.util.TextUtils;
/**
* Default implementation of {@link RedirectStrategy}. This strategy honors the restrictions
* on automatic redirection of entity enclosing methods such as POST and PUT imposed by the
- * HTTP specification. {@code 302 Moved Temporarily</tt>, <tt>301 Moved Permanently} and
+ * HTTP specification. {@code 302 Moved Temporarily}, {@code 301 Moved Permanently} and
* {@code 307 Temporary Redirect} status codes will result in an automatic redirect of
* HEAD and GET methods only. POST and PUT methods will not be automatically redirected
* as requiring user confirmation.
Modified: httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/impl/cookie/TestCookieRFC2965Spec.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/impl/cookie/TestCookieRFC2965Spec.java?rev=1612086&r1=1612085&r2=1612086&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/impl/cookie/TestCookieRFC2965Spec.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/test/java/org/apache/http/impl/cookie/TestCookieRFC2965Spec.java Sun Jul 20 13:42:19 2014
@@ -416,7 +416,7 @@ public class TestCookieRFC2965Spec {
}
/**
- * test parsing {@code "Comment"</tt>, <tt>"CommentURL"} and
+ * test parsing {@code "Comment"}, {@code "CommentURL"} and
* {@code "Secure"} attributes.
*/
@Test