Add documentation for HttpException 

Corresponds with https://github.com/tachiyomiorg/extensions-lib/pull/12
2023-08-18 22:28:14 -04:00 · 2023-08-18 22:28:14 -04:00 · d1c956401c
commit d1c956401c
parent 1be7949275
1 changed files with 7 additions and 0 deletions
--- a/core/src/main/java/eu/kanade/tachiyomi/network/OkHttpExtensions.kt
+++ b/core/src/main/java/eu/kanade/tachiyomi/network/OkHttpExtensions.kt
@ -143,4 +143,11 @@ fun <T> decodeFromJsonResponse(
    }
 }

+/**
+ * Exception that handles HTTP codes considered not successful by OkHttp.
+ * Use it to have a standardized error message in the app across the extensions.
+ *
+ * @since extensions-lib 1.5
+ * @param code [Int] the HTTP status code
+ */
 class HttpException(val code: Int) : IllegalStateException("HTTP error $code")