chore: Add kDoc for NetworkException

Infomaniak · Oct 15, 2024 · 87a3856 · 87a3856
1 parent 7ff7f94
commit 87a3856
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/.../kotlin/com/infomaniak/multiplatform_swisstransfer/network/exceptions/NetworkException.kt b/.../kotlin/com/infomaniak/multiplatform_swisstransfer/network/exceptions/NetworkException.kt
@@ -19,4 +19,12 @@ package com.infomaniak.multiplatform_swisstransfer.network.exceptions
 
 import io.ktor.utils.io.errors.IOException
 
+/**
+ * Thrown when a network-related error occurs, such as connectivity issues or timeouts.
+ *
+ * This exception is used to represent errors that occur during network operations,
+ * typically indicating problems with the connection, DNS resolution, or other network failures.
+ *
+ * @param message A detailed message describing the network error.
+ */
 class NetworkException(message: String) : IOException(message)