Przeglądaj źródła

Minor JavaDoc updates

arkon 1 rok temu
rodzic
commit
94c94b2d88

+ 6 - 5
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<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.
      */
@@ -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<Page> {