From 055fe408a64d045579838015b0045ccfc8c8d749 Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Fri, 14 Aug 2026 10:06:53 +0200
Subject: [PATCH] Add KDoc to the `features/roommembermoderation` API
 interfaces

Document RoomMemberModerationState, RoomMemberModerationEvents and
RoomMemberModerationRenderer along with their members and parameters.

The renderer doc states that it draws nothing until the host screen asks for a
member's actions, and that onSelectAction exists so the host can navigate for the
actions that need a screen of their own.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
---
 .../api/RoomMemberModerationEvents.kt                 |  3 +++
 .../api/RoomMemberModerationRenderer.kt               | 11 +++++++++++
 .../api/RoomMemberModerationState.kt                  |  6 ++++++
 3 files changed, 20 insertions(+)

diff --git a/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationEvents.kt b/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationEvents.kt
index 2238ff41df..d452ff4e66 100644
--- a/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationEvents.kt
+++ b/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationEvents.kt
@@ -10,6 +10,9 @@ package io.element.android.features.roommembermoderation.api
 
 import io.element.android.libraries.matrix.api.user.MatrixUser
 
+/**
+ * Events sent to the moderation presenter through [RoomMemberModerationState.eventSink].
+ */
 interface RoomMemberModerationEvents {
     data class ShowActionsForUser(val user: MatrixUser) : RoomMemberModerationEvents
     data class ProcessAction(val action: ModerationAction, val targetUser: MatrixUser) : RoomMemberModerationEvents
diff --git a/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationRenderer.kt b/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationRenderer.kt
index efc87d8a40..7696f826a1 100644
--- a/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationRenderer.kt
+++ b/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationRenderer.kt
@@ -12,7 +12,18 @@ import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
 import io.element.android.libraries.matrix.api.user.MatrixUser
 
+/**
+ * Renders the moderation action sheet and its confirmation dialogs; it draws nothing until the host screen asks for a member's actions.
+ */
 interface RoomMemberModerationRenderer {
+    /**
+     * Draws whichever sheet or dialog the current state calls for.
+     *
+     * @param state the state produced by the moderation presenter.
+     * @param onSelectAction called when the user picks an action, so the host screen can navigate if that action needs its own screen.
+     * @param onAvatarClick called when the user taps the member's avatar, or `null` to make it non-interactive.
+     * @param modifier layout modifier for the container.
+     */
     @Composable
     fun Render(
         state: RoomMemberModerationState,
diff --git a/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationState.kt b/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationState.kt
index c9ee958f6f..9227c77edf 100644
--- a/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationState.kt
+++ b/features/roommembermoderation/api/src/main/kotlin/io/element/android/features/roommembermoderation/api/RoomMemberModerationState.kt
@@ -10,9 +10,15 @@ package io.element.android.features.roommembermoderation.api
 
 import androidx.compose.runtime.Immutable
 
+/**
+ * State of the member moderation flow, which is the action sheet and the confirmation dialogs shown for a room member.
+ */
 @Immutable
 interface RoomMemberModerationState {
+    /** Which moderation actions the current user is allowed to perform, so the UI can hide or disable the rest. */
     val permissions: RoomMemberModerationPermissions
+
+    /** Where the host screen sends its events to open the actions of a member or run one of them. */
     val eventSink: (RoomMemberModerationEvents) -> Unit
 }