Add KDoc to the single-interface feature API modules

Cover the last remaining interfaces across features/announcement, cachecleaner,
call, contentscanner, createroom, knockrequests, lockscreen, rolesandpermissions,
startchat, userprofile and viewfolder, with their members and parameters.

Grouped into one commit rather than eleven near-empty ones, per the AGENTS.md rule
about tiny commits.

This completes every features/* api module.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Benoit Marty
2026-08-14 12:00:42 +02:00
parent 1b4d6c07fa
commit 9822b3d4f7
11 changed files with 85 additions and 0 deletions
@@ -22,8 +22,18 @@ fun interface ChangeRoomMemberRolesEntryPoint : FeatureEntryPoint {
listType: ChangeRoomMemberRolesListType,
): Node
/**
* Lets a caller outside this feature wait for the role change to finish, which is needed when leaving a room depends on it.
*/
interface NodeProxy {
/** The room whose member roles are being changed. */
val roomId: RoomId
/**
* Suspends until the user finishes or abandons the flow.
*
* @return true when roles were actually changed, false when the user backed out.
*/
suspend fun waitForCompletion(): Boolean
}
}