aboutsummaryrefslogtreecommitdiffstats
path: root/app/src/main/java/dev/msfjarvis/aps/injection/context/ContextModule.kt
diff options
context:
space:
mode:
Diffstat (limited to 'app/src/main/java/dev/msfjarvis/aps/injection/context/ContextModule.kt')
-rw-r--r--app/src/main/java/dev/msfjarvis/aps/injection/context/ContextModule.kt6
1 files changed, 3 insertions, 3 deletions
diff --git a/app/src/main/java/dev/msfjarvis/aps/injection/context/ContextModule.kt b/app/src/main/java/dev/msfjarvis/aps/injection/context/ContextModule.kt
index 0f1acac8..41e59bf9 100644
--- a/app/src/main/java/dev/msfjarvis/aps/injection/context/ContextModule.kt
+++ b/app/src/main/java/dev/msfjarvis/aps/injection/context/ContextModule.kt
@@ -12,9 +12,9 @@ import dagger.hilt.components.SingletonComponent
class ContextModule {
/**
- * A method which provides the path of app-specific files directory. This is useful where we want
- * to perform file operations but we do not want to depend on the [Context]. Injecting this in
- * place of [Context] allows the method/class to be unit-tested without any mocks/fakes.
+ * We inject [Context.getFilesDir] to break the dependency on [Context], allowing tests to run on
+ * the JVM. The principle here is identical to why [dev.msfjarvis.aps.util.totp.TotpFinder]
+ * exists.
*
* @param context [ApplicationContext]
* @return the path of app-specific files directory.