More docs and renamed annotation

Co-Authored-By: Jack Boswell <[email protected]>
imashnake0 · Jan 15, 2024 · b19f774 · b19f774
1 parent 577740d
commit b19f774
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/api/anilist/src/main/kotlin/com/imashnake/animite/api/anilist/AnilistApiModule.kt b/api/anilist/src/main/kotlin/com/imashnake/animite/api/anilist/AnilistApiModule.kt
@@ -43,7 +43,7 @@ object AnilistApiModule {
 
     @Provides
     @Singleton
-    @Authorized
+    @AuthorizedClient
     fun provideAuthorizedApolloClient(
         @ApplicationContext context: Context,
         httpInterceptor: HttpInterceptor
@@ -81,4 +81,4 @@ object AnilistApiModule {
 
 @Qualifier
 @Retention(AnnotationRetention.BINARY)
-annotation class Authorized
+annotation class AuthorizedClient
diff --git a/api/anilist/src/main/kotlin/com/imashnake/animite/api/anilist/AnilistMediaRepository.kt b/api/anilist/src/main/kotlin/com/imashnake/animite/api/anilist/AnilistMediaRepository.kt
@@ -11,6 +11,13 @@ import com.imashnake.animite.api.anilist.type.MediaType
 import kotlinx.coroutines.flow.Flow
 import javax.inject.Inject
 
+/**
+ * Repository for fetching [MediaQuery.Media] or a list of [MediaListQuery.Medium].
+ *
+ * @param apolloClient Default apollo client.
+ * @property fetchMediaList Fetches a list of [MediaListQuery.Medium].
+ * @property fetchMedia Fetches detailed media: [MediaQuery.Media].
+ */
 class AnilistMediaRepository @Inject constructor(
     private val apolloClient: ApolloClient
 ) {

diff --git a/api/anilist/src/main/kotlin/com/imashnake/animite/api/anilist/AnilistSearchRepository.kt b/api/anilist/src/main/kotlin/com/imashnake/animite/api/anilist/AnilistSearchRepository.kt
@@ -9,6 +9,12 @@ import com.imashnake.animite.api.anilist.type.MediaType
 import kotlinx.coroutines.flow.Flow
 import javax.inject.Inject
 
+/**
+ * Repository for fetching media search results (e.g., search bar).
+ *
+ * @param apolloClient Default apollo client.
+ * @property fetchSearch Fetch a list of `search`es.
+ */
 class AnilistSearchRepository @Inject constructor(
     private val apolloClient: ApolloClient
 ) {

diff --git a/api/anilist/src/main/kotlin/com/imashnake/animite/api/anilist/AnilistUserRepository.kt b/api/anilist/src/main/kotlin/com/imashnake/animite/api/anilist/AnilistUserRepository.kt
@@ -13,7 +13,7 @@ import javax.inject.Inject
  * @property fetchViewer Fetches the current user with an authorized [apolloClient].
  */
 class AnilistUserRepository @Inject constructor(
-    @Authorized private val apolloClient: ApolloClient
+    @AuthorizedClient private val apolloClient: ApolloClient
 ) {
     fun fetchViewer(): Flow<Result<ViewerQuery.Viewer>> {
         return apolloClient