Update the documentation for the CancelConfirmationDialog typealias.

SpineEventEngine · Oct 9, 2024 · e1aec90 · e1aec90
1 parent 8b6e2ba
commit e1aec90
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/core/src/main/kotlin/io/spine/chords/core/modal/ModalWindow.kt b/core/src/main/kotlin/io/spine/chords/core/modal/ModalWindow.kt
@@ -144,9 +144,13 @@ public data class ModalWindowConfig(
 )
 
 /**
- * A type of the cancel confirmation modal window.
+ * A type of the cancel confirmation dialog.
  *
- * @see CancelConfirmationDialogContainer
+ * The cancel confirmation dialog prompts the user to confirm whether they want to close
+ * the modal. It receives two parameters:
+ * - `onConfirm`: A callback triggered when the user confirms the cancellation.
+ * - `onCancel`: A callback triggered when the user cancels the cancellation
+ *   (i.e., decides not to close the modal).
  */
 public typealias CancelConfirmationDialog =
         @Composable BoxScope.(onConfirm: () -> Unit, onCancel: () -> Unit) -> Unit