From 3c93807fe63cead9e5aff7b5c68a8904d8c328ca Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoitm@matrix.org>
Date: Thu, 14 Nov 2019 17:46:53 +0100
Subject: [PATCH] Login screens: add some doc

---
 .../java/im/vector/riotx/features/login/LoginFragment.kt     | 5 +++--
 .../riotx/features/login/LoginServerSelectionFragment.kt     | 2 +-
 .../riotx/features/login/LoginServerUrlFormFragment.kt       | 2 +-
 .../features/login/LoginSignUpSignInSelectionFragment.kt     | 2 +-
 .../im/vector/riotx/features/login/LoginSplashFragment.kt    | 2 +-
 5 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/vector/src/main/java/im/vector/riotx/features/login/LoginFragment.kt b/vector/src/main/java/im/vector/riotx/features/login/LoginFragment.kt
index 166a733d8a..4a4ca5fce0 100644
--- a/vector/src/main/java/im/vector/riotx/features/login/LoginFragment.kt
+++ b/vector/src/main/java/im/vector/riotx/features/login/LoginFragment.kt
@@ -32,11 +32,12 @@ import kotlinx.android.synthetic.main.fragment_login.*
 import javax.inject.Inject
 
 /**
- * What can be improved:
- * - When filtering more (when entering new chars), we could filter on result we already have, during the new server request, to avoid empty screen effect
+ * In this screen, the user is asked for login and password to sign in to a homeserver.
+ * He also can reset his password
  */
 class LoginFragment @Inject constructor() : AbstractLoginFragment() {
 
+    // TODO Move to viewState?
     private var passwordShown = false
 
     override fun getLayoutResId() = R.layout.fragment_login
diff --git a/vector/src/main/java/im/vector/riotx/features/login/LoginServerSelectionFragment.kt b/vector/src/main/java/im/vector/riotx/features/login/LoginServerSelectionFragment.kt
index 0af00348ff..488bb340f5 100644
--- a/vector/src/main/java/im/vector/riotx/features/login/LoginServerSelectionFragment.kt
+++ b/vector/src/main/java/im/vector/riotx/features/login/LoginServerSelectionFragment.kt
@@ -27,7 +27,7 @@ import me.gujun.android.span.span
 import javax.inject.Inject
 
 /**
- *
+ * In this screen, the user will choose between matrix.org, modular or other type of homeserver
  */
 class LoginServerSelectionFragment @Inject constructor() : AbstractLoginFragment() {
 
diff --git a/vector/src/main/java/im/vector/riotx/features/login/LoginServerUrlFormFragment.kt b/vector/src/main/java/im/vector/riotx/features/login/LoginServerUrlFormFragment.kt
index 7304f15cf6..87043222f9 100644
--- a/vector/src/main/java/im/vector/riotx/features/login/LoginServerUrlFormFragment.kt
+++ b/vector/src/main/java/im/vector/riotx/features/login/LoginServerUrlFormFragment.kt
@@ -31,7 +31,7 @@ import kotlinx.android.synthetic.main.fragment_login_server_url_form.*
 import javax.inject.Inject
 
 /**
- *
+ * In this screen, the user is prompted to enter a homeserver url
  */
 class LoginServerUrlFormFragment @Inject constructor(
         private val errorFormatter: ErrorFormatter
diff --git a/vector/src/main/java/im/vector/riotx/features/login/LoginSignUpSignInSelectionFragment.kt b/vector/src/main/java/im/vector/riotx/features/login/LoginSignUpSignInSelectionFragment.kt
index eb855f93c1..dbf8abfe49 100644
--- a/vector/src/main/java/im/vector/riotx/features/login/LoginSignUpSignInSelectionFragment.kt
+++ b/vector/src/main/java/im/vector/riotx/features/login/LoginSignUpSignInSelectionFragment.kt
@@ -24,7 +24,7 @@ import kotlinx.android.synthetic.main.fragment_login_signup_signin_selection.*
 import javax.inject.Inject
 
 /**
- *
+ * In this screen, the user is asked to sign up or to sign in to the homeserver
  */
 class LoginSignUpSignInSelectionFragment @Inject constructor() : AbstractLoginFragment() {
 
diff --git a/vector/src/main/java/im/vector/riotx/features/login/LoginSplashFragment.kt b/vector/src/main/java/im/vector/riotx/features/login/LoginSplashFragment.kt
index 33db8fa81a..53de8c2c43 100644
--- a/vector/src/main/java/im/vector/riotx/features/login/LoginSplashFragment.kt
+++ b/vector/src/main/java/im/vector/riotx/features/login/LoginSplashFragment.kt
@@ -21,7 +21,7 @@ import im.vector.riotx.R
 import javax.inject.Inject
 
 /**
- *
+ * In this screen, the user is viewing an introduction to what he can do with this application
  */
 class LoginSplashFragment @Inject constructor() : AbstractLoginFragment() {