You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ol...@apache.org on 2024/01/25 10:08:02 UTC
(httpcomponents-core) branch 5.2.x updated: Mention HttpStatus and StatusCode in JavaDoc in more places (#454)
This is an automated email from the ASF dual-hosted git repository.
olegk pushed a commit to branch 5.2.x
in repository https://gitbox.apache.org/repos/asf/httpcomponents-core.git
The following commit(s) were added to refs/heads/5.2.x by this push:
new c68ce905d Mention HttpStatus and StatusCode in JavaDoc in more places (#454)
c68ce905d is described below
commit c68ce905d6244cc3b3f40b7f83c063ad5f760c40
Author: Dmitrii Naumenko <di...@mail.ru>
AuthorDate: Thu Jan 25 11:04:15 2024 +0100
Mention HttpStatus and StatusCode in JavaDoc in more places (#454)
* Add JavaDoc @see cross-references between HttpStatus and StatusClass
* Mention HttpStatus in JavaDoc of HttpResponse.getCode
---
httpcore5/src/main/java/org/apache/hc/core5/http/HttpResponse.java | 2 ++
httpcore5/src/main/java/org/apache/hc/core5/http/HttpStatus.java | 2 ++
.../src/main/java/org/apache/hc/core5/http/message/StatusLine.java | 2 ++
3 files changed, 6 insertions(+)
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/HttpResponse.java b/httpcore5/src/main/java/org/apache/hc/core5/http/HttpResponse.java
index 9b67eee8b..80c86e496 100644
--- a/httpcore5/src/main/java/org/apache/hc/core5/http/HttpResponse.java
+++ b/httpcore5/src/main/java/org/apache/hc/core5/http/HttpResponse.java
@@ -41,6 +41,8 @@ public interface HttpResponse extends HttpMessage {
* Obtains the code of this response message.
*
* @return the status code.
+ *
+ * @see HttpStatus
*/
int getCode();
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/HttpStatus.java b/httpcore5/src/main/java/org/apache/hc/core5/http/HttpStatus.java
index 02b448c1a..993f50425 100644
--- a/httpcore5/src/main/java/org/apache/hc/core5/http/HttpStatus.java
+++ b/httpcore5/src/main/java/org/apache/hc/core5/http/HttpStatus.java
@@ -45,6 +45,8 @@ package org.apache.hc.core5.http;
* @see <a href="https://tools.ietf.org/html/rfc2817">RFC 2817 (Upgrading to TLS Within HTTP/1.1)</a>
* @see <a href="https://tools.ietf.org/html/rfc8470">RFC 8470 (Using Early Data in HTTP)</a>
* @since 4.0
+ * @see org.apache.hc.core5.http.message.StatusLine.StatusClass
+ * @see org.apache.hc.core5.http.message.StatusLine.StatusClass#from(int)
*/
public final class HttpStatus {
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/message/StatusLine.java b/httpcore5/src/main/java/org/apache/hc/core5/http/message/StatusLine.java
index 9eb52f4ba..9cc8aaea2 100644
--- a/httpcore5/src/main/java/org/apache/hc/core5/http/message/StatusLine.java
+++ b/httpcore5/src/main/java/org/apache/hc/core5/http/message/StatusLine.java
@@ -174,6 +174,7 @@ public final class StatusLine implements Serializable {
/**
* Standard classes of HTTP status codes, plus {@code OTHER} for non-standard codes.
+ * @see org.apache.hc.core5.http.HttpStatus
*/
public enum StatusClass {
@@ -212,6 +213,7 @@ public final class StatusLine implements Serializable {
*
* @param statusCode response status code to get the class for.
* @return class of the response status code.
+ * @see org.apache.hc.core5.http.HttpStatus
*/
public static StatusClass from(final int statusCode) {
final StatusClass statusClass;