diff options
| author | Aditya Wasan <adityawasan55@gmail.com> | 2021-05-22 19:48:30 +0530 |
|---|---|---|
| committer | Harsh Shandilya <me@msfjarvis.dev> | 2021-05-22 20:05:56 +0530 |
| commit | a2741cd871d91758950848ef5ae123bbc5b1d6b7 (patch) | |
| tree | c089bf356df19e0f8162f92e44f183d8d0a35fdf /app/src/main/java/dev/msfjarvis/aps/injection/context/ContextModule.kt | |
| parent | d9d18069abeccea795d82f917ed2b56f8199d406 (diff) | |
| download | HardenedPass-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/context/ContextModule.kt')
| -rw-r--r-- | app/src/main/java/dev/msfjarvis/aps/injection/context/ContextModule.kt | 8 |
1 files changed, 8 insertions, 0 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 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 { |