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 2024/05/22 17:49:59 UTC
(httpcomponents-client) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/httpcomponents-client.git
The following commit(s) were added to refs/heads/master by this push:
new 15b93d481 Javadoc
15b93d481 is described below
commit 15b93d481b17bba267f2ba68dbb50fc71f44cce6
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Wed May 22 13:49:54 2024 -0400
Javadoc
- Add generic type documentation
- Add parameter documentation
---
.../org/apache/hc/client5/http/AbstractClientContextBuilder.java | 1 +
.../java/org/apache/hc/client5/http/ConnectTimeoutException.java | 5 +++++
.../java/org/apache/hc/client5/http/UnsupportedSchemeException.java | 2 ++
3 files changed, 8 insertions(+)
diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/AbstractClientContextBuilder.java b/httpclient5/src/main/java/org/apache/hc/client5/http/AbstractClientContextBuilder.java
index 1358d9cbc..b54dec3f8 100644
--- a/httpclient5/src/main/java/org/apache/hc/client5/http/AbstractClientContextBuilder.java
+++ b/httpclient5/src/main/java/org/apache/hc/client5/http/AbstractClientContextBuilder.java
@@ -48,6 +48,7 @@ import org.apache.hc.core5.util.Args;
/**
* Abstract {@link HttpClientContext} builder.
*
+ * @param <T> The HttpClientContext type or subtype.
* @since 5.4
*/
public abstract class AbstractClientContextBuilder<T extends HttpClientContext> {
diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/ConnectTimeoutException.java b/httpclient5/src/main/java/org/apache/hc/client5/http/ConnectTimeoutException.java
index efb0f0a91..98eefb2fa 100644
--- a/httpclient5/src/main/java/org/apache/hc/client5/http/ConnectTimeoutException.java
+++ b/httpclient5/src/main/java/org/apache/hc/client5/http/ConnectTimeoutException.java
@@ -44,6 +44,8 @@ public class ConnectTimeoutException extends SocketTimeoutException {
/**
* Creates a ConnectTimeoutException with the specified detail message.
+ *
+ * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
*/
public ConnectTimeoutException(final String message) {
super(message);
@@ -56,6 +58,9 @@ public class ConnectTimeoutException extends SocketTimeoutException {
}
/**
+ * Gets the named endpoint.
+ *
+ * @return the named endpoint, may be {@code null}.
* @since 5.0
*/
public NamedEndpoint getHost() {
diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/UnsupportedSchemeException.java b/httpclient5/src/main/java/org/apache/hc/client5/http/UnsupportedSchemeException.java
index bf445fad7..5e20bc8c1 100644
--- a/httpclient5/src/main/java/org/apache/hc/client5/http/UnsupportedSchemeException.java
+++ b/httpclient5/src/main/java/org/apache/hc/client5/http/UnsupportedSchemeException.java
@@ -40,6 +40,8 @@ public class UnsupportedSchemeException extends IOException {
/**
* Creates a UnsupportedSchemeException with the specified detail message.
+ *
+ * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
*/
public UnsupportedSchemeException(final String message) {
super(message);