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
apache · Jan 25, 2024 · c68ce90 · c68ce90
1 parent 30b3a20
commit c68ce90
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
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
@@ -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
@@ -45,6 +45,8 @@
  * @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
@@ -174,6 +174,7 @@ public String toString() {
 
     /**
      * 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 enum StatusClass {
          *
          * @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;