Use Kdoc format, else it's not extracted to the documentation by dokka

This commit is contained in:
Benoit Marty 2022-05-05 17:00:07 +02:00 committed by Benoit Marty
parent 109b381e2e
commit bad62be497
5 changed files with 85 additions and 31 deletions

View File

@ -51,33 +51,51 @@ package org.matrix.android.sdk.api.session.crypto.keysbackup
* </pre> * </pre>
*/ */
enum class KeysBackupState { enum class KeysBackupState {
// Need to check the current backup version on the homeserver /**
* Need to check the current backup version on the homeserver
*/
Unknown, Unknown,
// Checking if backup is enabled on homeserver /**
* Checking if backup is enabled on homeserver
*/
CheckingBackUpOnHomeserver, CheckingBackUpOnHomeserver,
// Backup has been stopped because a new backup version has been detected on the homeserver /**
* Backup has been stopped because a new backup version has been detected on the homeserver
*/
WrongBackUpVersion, WrongBackUpVersion,
// Backup from this device is not enabled /**
* Backup from this device is not enabled
*/
Disabled, Disabled,
// There is a backup available on the homeserver but it is not trusted. /**
// It is not trusted because the signature is invalid or the device that created it is not verified * There is a backup available on the homeserver but it is not trusted.
// Use [KeysBackup.getKeysBackupTrust()] to get trust details. * It is not trusted because the signature is invalid or the device that created it is not verified
// Consequently, the backup from this device is not enabled. * Use [KeysBackup.getKeysBackupTrust()] to get trust details.
* Consequently, the backup from this device is not enabled.
*/
NotTrusted, NotTrusted,
// Backup is being enabled: the backup version is being created on the homeserver /**
* Backup is being enabled: the backup version is being created on the homeserver
*/
Enabling, Enabling,
// Backup is enabled and ready to send backup to the homeserver /**
* Backup is enabled and ready to send backup to the homeserver
*/
ReadyToBackUp, ReadyToBackUp,
// e2e keys are going to be sent to the homeserver /**
* e2e keys are going to be sent to the homeserver
*/
WillBackUp, WillBackUp,
// e2e keys are being sent to the homeserver /**
* e2e keys are being sent to the homeserver
*/
BackingUp BackingUp
} }

View File

@ -20,15 +20,23 @@ package org.matrix.android.sdk.api.session.crypto.model
* RoomEncryptionTrustLevel represents the trust level in an encrypted room. * RoomEncryptionTrustLevel represents the trust level in an encrypted room.
*/ */
enum class RoomEncryptionTrustLevel { enum class RoomEncryptionTrustLevel {
// No one in the room has been verified -> Black shield /**
* No one in the room has been verified -> Black shield
*/
Default, Default,
// There are one or more device un-verified -> the app should display a red shield /**
* There are one or more device un-verified -> the app should display a red shield
*/
Warning, Warning,
// All devices in the room are verified -> the app should display a green shield /**
* All devices in the room are verified -> the app should display a green shield
*/
Trusted, Trusted,
// e2e is active but with an unsupported algorithm /**
* e2e is active but with an unsupported algorithm
*/
E2EWithUnsupportedAlgorithm E2EWithUnsupportedAlgorithm
} }

View File

@ -20,12 +20,18 @@ package org.matrix.android.sdk.api.session.crypto.verification
* Verification methods. * Verification methods.
*/ */
enum class VerificationMethod { enum class VerificationMethod {
// Use it when your application supports the SAS verification method /**
* Use it when your application supports the SAS verification method
*/
SAS, SAS,
// Use it if your application is able to display QR codes /**
* Use it if your application is able to display QR codes
*/
QR_CODE_SHOW, QR_CODE_SHOW,
// Use it if your application is able to scan QR codes /**
* Use it if your application is able to scan QR codes
*/
QR_CODE_SCAN QR_CODE_SCAN
} }

View File

@ -17,27 +17,44 @@
package org.matrix.android.sdk.api.session.room.send package org.matrix.android.sdk.api.session.room.send
enum class SendState { enum class SendState {
/**
* The state is unknown
*/
UNKNOWN, UNKNOWN,
// the event has not been sent /**
* The event has not been sent
*/
UNSENT, UNSENT,
// the event is encrypting /**
* The event is encrypting
*/
ENCRYPTING, ENCRYPTING,
// the event is currently sending /**
* The event is currently sending
*/
SENDING, SENDING,
// the event has been sent /**
* The event has been sent
*/
SENT, SENT,
// the event has been received from server /**
* The event has been received from server
*/
SYNCED, SYNCED,
// The event failed to be sent /**
* The event failed to be sent
*/
UNDELIVERED, UNDELIVERED,
// the event failed to be sent because some unknown devices have been found while encrypting it /**
* The event failed to be sent because some unknown devices have been found while encrypting it
*/
FAILED_UNKNOWN_DEVICES; FAILED_UNKNOWN_DEVICES;
internal companion object { internal companion object {

View File

@ -20,14 +20,19 @@ package org.matrix.android.sdk.api.session.threads
* This class defines the state of a thread notification. * This class defines the state of a thread notification.
*/ */
enum class ThreadNotificationState { enum class ThreadNotificationState {
/**
// There are no new message * There are no new message
*/
NO_NEW_MESSAGE, NO_NEW_MESSAGE,
// There is at least one new message /**
* There is at least one new message
*/
NEW_MESSAGE, NEW_MESSAGE,
// The is at least one new message that should be highlighted /**
// ex. "Hello @aris.kotsomitopoulos" * The is at least one new message that should be highlighted
* ex. "Hello @aris.kotsomitopoulos"
*/
NEW_HIGHLIGHTED_MESSAGE; NEW_HIGHLIGHTED_MESSAGE;
} }