From 1f97e95a3dc63c1494c33832203bcd272e89f5b4 Mon Sep 17 00:00:00 2001 From: ganfra Date: Wed, 18 Oct 2023 11:33:34 +0200 Subject: [PATCH] Fix warning --- .../features/lockscreen/impl/pin/PinCodeManager.kt | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/features/lockscreen/impl/src/main/kotlin/io/element/android/features/lockscreen/impl/pin/PinCodeManager.kt b/features/lockscreen/impl/src/main/kotlin/io/element/android/features/lockscreen/impl/pin/PinCodeManager.kt index 960b6ecba1..5f84f5296d 100644 --- a/features/lockscreen/impl/src/main/kotlin/io/element/android/features/lockscreen/impl/pin/PinCodeManager.kt +++ b/features/lockscreen/impl/src/main/kotlin/io/element/android/features/lockscreen/impl/pin/PinCodeManager.kt @@ -27,28 +27,30 @@ interface PinCodeManager { suspend fun isPinCodeAvailable(): Boolean /** - * creates a new encrypted pin code. + * Creates a new encrypted pin code. * @param pinCode the clear pin code to create */ suspend fun createPinCode(pinCode: String) /** - * @return true if the pin code is correct + * @return true if the pin code is correct. */ suspend fun verifyPinCode(pinCode: String): Boolean /** - * deletes the previously created pin code + * Deletes the previously created pin code. */ suspend fun deletePinCode() /** - * @return the number of remaining attempts before the pin code is blocked + * @return the number of remaining attempts before the pin code is blocked. */ suspend fun getRemainingPinCodeAttemptsNumber(): Int /** - * @return the number of remaining attempts before the pin code is blocked + * Should be called when the pin code is incorrect. + * Will decrement the remaining attempts number. + * @return the number of remaining attempts before the pin code is blocked. */ suspend fun onWrongPin(): Int