add kdoc for pagination

This commit is contained in:
InsanusMokrassar 2019-11-01 13:58:38 +06:00
parent febf442faa
commit eae3212c01

View File

@ -1,6 +1,20 @@
package com.insanusmokrassar.postssystem.core.utils.pagination
/**
* Base interface of pagination
*
* If you want to request something, you should use [SimplePagination]. If you need to return some result including
* pagination - [PaginationResult]
*/
interface Pagination {
/**
* Started with 0.
* Number of page inside of pagination. Offset can be calculated as [page] * [size]
*/
val page: Int
/**
* Can be 0, but can't be < 0
* Size of current page. Offset can be calculated as [page] * [size]
*/
val size: Int
}