github/mihon
1
0
Fork 0
mirror of https://github.com/mihonapp/mihon.git synced 2024-11-07 20:31:02 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Minor JavaDoc updates

Browse source
This commit is contained in:
arkon 2023-04-22 11:15:45 -04:00
parent 41cc1fe723
commit 94c94b2d88
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
source-api/src/commonMain/kotlin/eu/kanade/tachiyomi/source/Source.kt
View file

@ -7,12 +7,12 @@ import eu.kanade.tachiyomi.util.awaitSingle
import rx.Observable 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 { interface Source {
/** /**
* Id for the source. Must be unique. * ID for the source. Must be unique.
*/ */
val id: Long val id: Long
@ -46,9 +46,9 @@ interface Source {
) )
fun fetchChapterList(manga: SManga): Observable<List<SChapter>> = throw IllegalStateException("Not used") fun fetchChapterList(manga: SManga): Observable<List<SChapter>> = 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. * @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") @Suppress("DEPRECATION")
suspend fun getPageList(chapter: SChapter): List<Page> { suspend fun getPageList(chapter: SChapter): List<Page> {