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 --- .../java/dev/msfjarvis/aps/injection/context/ContextModule.kt | 8 ++++++++ 1 file changed, 8 insertions(+) (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 6399781e..0f1acac8 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 @@ -11,6 +11,14 @@ import dagger.hilt.components.SingletonComponent @InstallIn(SingletonComponent::class) 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. + * + * @param context [ApplicationContext] + * @return the path of app-specific files directory. + */ @Provides @FilesDirPath fun providesFilesDirPath(@ApplicationContext context: Context): String { -- cgit v1.2.3