chore: Add kDoc for ApiException

Infomaniak · Oct 11, 2024 · 8c83bd2 · 8c83bd2
1 parent 59a0814
commit 8c83bd2
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/...Main/kotlin/com/infomaniak/multiplatform_swisstransfer/network/exceptions/ApiException.kt b/...Main/kotlin/com/infomaniak/multiplatform_swisstransfer/network/exceptions/ApiException.kt
@@ -17,4 +17,13 @@
  */
 package com.infomaniak.multiplatform_swisstransfer.network.exceptions
 
+/**
+ * Thrown when an API call fails due to an error identified by a specific error code.
+ *
+ * This exception is used to represent errors returned by an API, with an associated error code
+ * and message describing the problem.
+ *
+ * @param errorCode The specific error code returned by the API.
+ * @param errorMessage The detailed error message explaining the cause of the failure.
+ */
 open class ApiException(val errorCode: Int, errorMessage: String) : Exception(errorMessage)