From a2741cd871d91758950848ef5ae123bbc5b1d6b7 Mon Sep 17 00:00:00 2001 From: Aditya Wasan Date: Sat, 22 May 2021 19:48:30 +0530 Subject: docs: Document qualifiers Signed-off-by: Aditya Wasan --- .../main/java/dev/msfjarvis/aps/injection/prefs/GitPreferences.kt | 6 ++++++ .../main/java/dev/msfjarvis/aps/injection/prefs/ProxyPreferences.kt | 6 ++++++ 2 files changed, 12 insertions(+) (limited to 'app/src/main/java/dev/msfjarvis/aps/injection/prefs') 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 -- cgit v1.2.3