From f66652cbc60ec11773b1435aebd3636b1dc9f5e1 Mon Sep 17 00:00:00 2001 From: Harsh Shandilya Date: Sat, 22 May 2021 20:04:36 +0530 Subject: Tweak documentation and drop unused import Signed-off-by: Harsh Shandilya --- .../main/java/dev/msfjarvis/aps/injection/context/ContextModule.kt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'app/src/main/java/dev/msfjarvis/aps/injection/context/ContextModule.kt') 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. -- cgit v1.2.3