Skip to content

Commit 6c0b508

Browse files
committed
Improve doc
1 parent 670698d commit 6c0b508

File tree

1 file changed

+6
-0
lines changed
  • readium/shared/src/main/java/org/readium/r2/shared/util/http

1 file changed

+6
-0
lines changed

readium/shared/src/main/java/org/readium/r2/shared/util/http/HttpError.kt

+6
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,23 @@ public sealed class HttpError(
2121
public override val cause: Error? = null
2222
) : AccessError {
2323

24+
/** Malformed HTTP response. */
2425
public class MalformedResponse(cause: Error?) :
2526
HttpError("The received response could not be decoded.", cause)
2627

2728
/** The client, server or gateways timed out. */
2829
public class Timeout(cause: Error) :
2930
HttpError("Request timed out.", cause)
3031

32+
/** Server could not be reached. */
3133
public class Unreachable(cause: Error) :
3234
HttpError("Server could not be reached.", cause)
3335

36+
/** Redirection failed. */
3437
public class Redirection(cause: Error) :
3538
HttpError("Redirection failed.", cause)
3639

40+
/** SSL Handshake failed. */
3741
public class SslHandshake(cause: Error) :
3842
HttpError("SSL handshake failed.", cause)
3943

@@ -45,6 +49,8 @@ public sealed class HttpError(
4549
}
4650

4751
/**
52+
* Server responded with an error status code.
53+
*
4854
* @param status HTTP status code.
4955
* @param mediaType Response media type.
5056
* @param body Response body.

0 commit comments

Comments
 (0)