From 94c94b2d883c103822d8a30288b6ab419a380506 Mon Sep 17 00:00:00 2001 From: arkon Date: Sat, 22 Apr 2023 11:15:45 -0400 Subject: [PATCH] Minor JavaDoc updates --- .../kotlin/eu/kanade/tachiyomi/source/Source.kt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/source-api/src/commonMain/kotlin/eu/kanade/tachiyomi/source/Source.kt b/source-api/src/commonMain/kotlin/eu/kanade/tachiyomi/source/Source.kt index 9364d95ec..5f5dd57ee 100644 --- a/source-api/src/commonMain/kotlin/eu/kanade/tachiyomi/source/Source.kt +++ b/source-api/src/commonMain/kotlin/eu/kanade/tachiyomi/source/Source.kt @@ -7,12 +7,12 @@ import eu.kanade.tachiyomi.util.awaitSingle import rx.Observable /** - * A basic interface for creating a source. It could be an online source, a local source, etc... + * A basic interface for creating a source. It could be an online source, a local source, etc. */ interface Source { /** - * Id for the source. Must be unique. + * ID for the source. Must be unique. */ val id: Long @@ -46,9 +46,9 @@ interface Source { ) fun fetchChapterList(manga: SManga): Observable> = throw IllegalStateException("Not used") - // TODO: remove direct usages on this method /** - * Returns an observable with the list of pages a chapter has. + * Returns an observable with the list of pages a chapter has. Pages should be returned + * in the expected order; the index is ignored. * * @param chapter the chapter. */ @@ -75,7 +75,8 @@ interface Source { } /** - * [1.x API] Get the list of pages a chapter has. + * [1.x API] Get the list of pages a chapter has. Pages should be returned + * in the expected order; the index is ignored. */ @Suppress("DEPRECATION") suspend fun getPageList(chapter: SChapter): List {