From 87a3856513cd4d9a747474c2f301f5ac750e89a9 Mon Sep 17 00:00:00 2001 From: Abdourahamane Boinaidi Date: Fri, 11 Oct 2024 17:09:10 +0200 Subject: [PATCH] chore: Add kDoc for NetworkException --- .../network/exceptions/NetworkException.kt | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/STNetwork/src/commonMain/kotlin/com/infomaniak/multiplatform_swisstransfer/network/exceptions/NetworkException.kt b/STNetwork/src/commonMain/kotlin/com/infomaniak/multiplatform_swisstransfer/network/exceptions/NetworkException.kt index c4f588ad..31254a1d 100644 --- a/STNetwork/src/commonMain/kotlin/com/infomaniak/multiplatform_swisstransfer/network/exceptions/NetworkException.kt +++ b/STNetwork/src/commonMain/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)