aboutsummaryrefslogtreecommitdiffstats
path: root/app/src/main/java/dev/msfjarvis/aps/injection/prefs
diff options
context:
space:
mode:
authorAditya Wasan <adityawasan55@gmail.com>2021-05-22 19:48:30 +0530
committerHarsh Shandilya <me@msfjarvis.dev>2021-05-22 20:05:56 +0530
commita2741cd871d91758950848ef5ae123bbc5b1d6b7 (patch)
treec089bf356df19e0f8162f92e44f183d8d0a35fdf /app/src/main/java/dev/msfjarvis/aps/injection/prefs
parentd9d18069abeccea795d82f917ed2b56f8199d406 (diff)
downloadHardenedPass-a2741cd871d91758950848ef5ae123bbc5b1d6b7.tar.gz
HardenedPass-a2741cd871d91758950848ef5ae123bbc5b1d6b7.zip
docs: Document qualifiers
Signed-off-by: Aditya Wasan <adityawasan55@gmail.com>
Diffstat (limited to 'app/src/main/java/dev/msfjarvis/aps/injection/prefs')
-rw-r--r--app/src/main/java/dev/msfjarvis/aps/injection/prefs/GitPreferences.kt6
-rw-r--r--app/src/main/java/dev/msfjarvis/aps/injection/prefs/ProxyPreferences.kt6
2 files changed, 12 insertions, 0 deletions
diff --git a/app/src/main/java/dev/msfjarvis/aps/injection/prefs/GitPreferences.kt b/app/src/main/java/dev/msfjarvis/aps/injection/prefs/GitPreferences.kt
index 749eea48..69de66f2 100644
--- a/app/src/main/java/dev/msfjarvis/aps/injection/prefs/GitPreferences.kt
+++ b/app/src/main/java/dev/msfjarvis/aps/injection/prefs/GitPreferences.kt
@@ -1,5 +1,11 @@
package dev.msfjarvis.aps.injection.prefs
+import android.content.SharedPreferences
+import dev.msfjarvis.aps.util.settings.GitSettings
import javax.inject.Qualifier
+/**
+ * Qualifier for a [SharedPreferences] that needs to be provided to the [GitSettings]. It provides a
+ * [SharedPreferences] with the file name "git_operation" which stores the git settings.
+ */
@Qualifier @Retention(AnnotationRetention.RUNTIME) annotation class GitPreferences
diff --git a/app/src/main/java/dev/msfjarvis/aps/injection/prefs/ProxyPreferences.kt b/app/src/main/java/dev/msfjarvis/aps/injection/prefs/ProxyPreferences.kt
index 786087ad..67d6f4dc 100644
--- a/app/src/main/java/dev/msfjarvis/aps/injection/prefs/ProxyPreferences.kt
+++ b/app/src/main/java/dev/msfjarvis/aps/injection/prefs/ProxyPreferences.kt
@@ -1,5 +1,11 @@
package dev.msfjarvis.aps.injection.prefs
+import android.content.SharedPreferences
+import dev.msfjarvis.aps.util.settings.GitSettings
import javax.inject.Qualifier
+/**
+ * Qualifier for a [SharedPreferences] that needs to be provided to the [GitSettings]. It provides a
+ * [SharedPreferences] with the file name "http_proxy" which stores all the http proxy settings.
+ */
@Qualifier @Retention(AnnotationRetention.RUNTIME) annotation class ProxyPreferences