Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mention HttpStatus and StatusCode in JavaDoc in more places #454

Merged
merged 2 commits into from
Jan 25, 2024
Merged

Mention HttpStatus and StatusCode in JavaDoc in more places #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bcdfc5
Add JavaDoc @see cross-references between HttpStatus and StatusClass
unkarjedy Jan 25, 2024
2b0a7b5
Mention HttpStatus in JavaDoc of HttpResponse.getCode
unkarjedy Jan 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions httpcore5/src/main/java/org/apache/hc/core5/http/HttpResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ public interface HttpResponse extends HttpMessage {
* Obtains the code of this response message.
*
* @return the status code.
*
* @see HttpStatus
*/
int getCode();

Expand Down
2 changes: 2 additions & 0 deletions httpcore5/src/main/java/org/apache/hc/core5/http/HttpStatus.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
* Constants enumerating the HTTP status codes.
*
* @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 {

Expand Down
2 changes: 2 additions & 0 deletions httpcore5/src/main/java/org/apache/hc/core5/http/message/StatusLine.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down Expand Up @@ -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;
Expand Down
Loading