From fa123d941b8542fb8458840495547d9b9c3af157 Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Fri, 14 Aug 2026 11:51:32 +0200
Subject: [PATCH] Add KDoc to the `features/invite` API interfaces

Document AcceptDeclineInviteEvents, AcceptDeclineInviteView and the
SeenInvitesStore interface.

The view doc explains why it is a shared component rather than part of one screen:
it is embedded everywhere an invitation can be acted on, so the confirmation
dialogs behave identically in the invite list and in a room preview.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
---
 .../android/features/invite/api/SeenInvitesStore.kt |  5 ++++-
 .../api/acceptdecline/AcceptDeclineInviteEvents.kt  |  3 +++
 .../api/acceptdecline/AcceptDeclineInviteView.kt    | 13 +++++++++++++
 3 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/SeenInvitesStore.kt b/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/SeenInvitesStore.kt
index 046303ca4f..d8ab7c71c8 100644
--- a/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/SeenInvitesStore.kt
+++ b/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/SeenInvitesStore.kt
@@ -11,6 +11,9 @@ package io.element.android.features.invite.api
 import io.element.android.libraries.matrix.api.core.RoomId
 import kotlinx.coroutines.flow.Flow
 
+/**
+ * Remembers which invitations the user has already looked at, so that only genuinely new ones are highlighted in the room list.
+ */
 interface SeenInvitesStore {
     /**
      * Returns a flow of seen room IDs of invitation.
@@ -32,7 +35,7 @@ interface SeenInvitesStore {
     suspend fun markAsUnSeen(roomId: RoomId)
 
     /**
-     * Delete the store.
+     * Delete the store, so every invitation counts as unseen again.
      */
     suspend fun clear()
 }
diff --git a/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/acceptdecline/AcceptDeclineInviteEvents.kt b/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/acceptdecline/AcceptDeclineInviteEvents.kt
index 2caaacab2b..5691b19ef7 100644
--- a/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/acceptdecline/AcceptDeclineInviteEvents.kt
+++ b/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/acceptdecline/AcceptDeclineInviteEvents.kt
@@ -10,6 +10,9 @@ package io.element.android.features.invite.api.acceptdecline
 
 import io.element.android.features.invite.api.InviteData
 
+/**
+ * Events sent to the accept/decline invite presenter, from whichever screen is showing the invitation.
+ */
 interface AcceptDeclineInviteEvents {
     data class AcceptInvite(val invite: InviteData) : AcceptDeclineInviteEvents
     data class DeclineInvite(val invite: InviteData, val blockUser: Boolean, val shouldConfirm: Boolean) : AcceptDeclineInviteEvents
diff --git a/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/acceptdecline/AcceptDeclineInviteView.kt b/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/acceptdecline/AcceptDeclineInviteView.kt
index b6eec03a6f..6e9d78082b 100644
--- a/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/acceptdecline/AcceptDeclineInviteView.kt
+++ b/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/acceptdecline/AcceptDeclineInviteView.kt
@@ -12,7 +12,20 @@ import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
 import io.element.android.libraries.matrix.api.core.RoomId
 
+/**
+ * Renders the confirmation dialogs and error states of accepting or declining an invitation; it draws nothing until such an event is sent.
+ *
+ * Embedded by every screen that can act on an invitation, so the behaviour stays identical between the invite list and a room preview.
+ */
 fun interface AcceptDeclineInviteView {
+    /**
+     * Draws whichever dialog the current state calls for.
+     *
+     * @param state the state produced by the accept/decline presenter.
+     * @param onAcceptInviteSuccess called once the room has been joined, so the host screen can navigate into it.
+     * @param onDeclineInviteSuccess called once the invitation has been declined.
+     * @param modifier layout modifier for the container.
+     */
     @Composable
     fun Render(
         state: AcceptDeclineInviteState,