#635 - Fix bad javadoc comment, and add clarifying javadoc to AuthenticationTask

This commit is contained in:
Joshua Soberg 2021-02-02 13:25:45 -05:00
parent 3eb0094204
commit bc8bcf834f
2 changed files with 6 additions and 1 deletions

View file

@ -246,7 +246,7 @@ public class AuthenticateActivity extends ThemedActivity
super.onBackPressed(); super.onBackPressed();
} }
/** Retained instance fragment to hold a running @link{{@link AuthenticationTask}} between configuration changes.*/ /** Retained instance fragment to hold a running {@link AuthenticationTask} between configuration changes.*/
public static class TaskFragment extends Fragment { public static class TaskFragment extends Fragment {
AuthenticationTask task; AuthenticationTask task;

View file

@ -28,6 +28,11 @@ public class AuthenticationTask extends UiBasedBackgroundTask<Result> {
private final String existingAuthCredentials; private final String existingAuthCredentials;
private final String plainPassword; private final String plainPassword;
/**
* @param context Context to be used to query settings (the application Context will be used to avoid memory leaks).
* @param isAuthUpgrade true if this is an authentication upgrade and new credentials should be saved, false if this is just confirmation.
* @param existingAuthCredentials The existing hashed authentication credentials that we have stored.
* @param plainPassword The plaintext user-entered password to check authentication with. */
public AuthenticationTask(Context context, boolean isAuthUpgrade, String existingAuthCredentials, String plainPassword) { public AuthenticationTask(Context context, boolean isAuthUpgrade, String existingAuthCredentials, String plainPassword) {
super(Result.failure()); super(Result.failure());
Context applicationContext = context.getApplicationContext(); Context applicationContext = context.getApplicationContext();