Add KDoc to the authentication, logout, preferences and share API interfaces

Cover the remaining interfaces of features/login, features/logout,
features/preferences and features/share, along with their members and parameters.

Points recorded here: AccountProviderAccessControl returns true on a build with no
enterprise restriction, ExtraDeveloperOptionsRenderer is bound to a no-op in the
standard build, DirectLogoutView draws nothing until a logout event is sent, and
CacheService exists because clearing a cache destroys the client and the app has
to react.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Benoit Marty
2026-08-14 11:53:37 +02:00
parent fa123d941b
commit 1b4d6c07fa
7 changed files with 40 additions and 0 deletions
@@ -11,5 +11,8 @@ package io.element.android.features.share.api
* Post-processing to be done once a [ShareIntentData] has been consumed.
*/
fun interface OnSharedData {
/**
* @param data the shared content that has just been handled, so any temporary copy of it can be released.
*/
operator fun invoke(data: ShareIntentData)
}
@@ -9,10 +9,14 @@ package io.element.android.features.share.api
import android.content.Intent
/**
* Recognises the intents another app uses to share content into this one, and resolves what was shared.
*/
interface ShareIntentHandler {
/**
* This methods aims to handle incoming share intents and parse its data.
*
* @param intent the intent the app was started with.
* @return the [ShareIntentData] if it could be resolved, or null.
*/
fun handleIncomingShareIntent(