From d1e0610d156e2917958bba2cd9f801832f3a6b8b Mon Sep 17 00:00:00 2001
From: DareFox <easymalink@gmail.com>
Date: Mon, 13 Jun 2022 11:58:10 +0300
Subject: [PATCH] API Docs: Change description from russian to english

---
 .../kotlin/kmtt/api/comment/ICommentAPI.kt    | 10 ++--
 .../kotlin/kmtt/api/user/IPublicUserAPI.kt    | 48 ++++++++++++-------
 2 files changed, 35 insertions(+), 23 deletions(-)

diff --git a/src/main/kotlin/kmtt/api/comment/ICommentAPI.kt b/src/main/kotlin/kmtt/api/comment/ICommentAPI.kt
index 78ac7f28..0f6325fc 100644
--- a/src/main/kotlin/kmtt/api/comment/ICommentAPI.kt
+++ b/src/main/kotlin/kmtt/api/comment/ICommentAPI.kt
@@ -13,22 +13,22 @@ import kmtt.models.enums.SortingType
  */
 interface IPublicCommentAPI {
     /**
-     * Получить комментарии к записи
+     * Get comments to an entry
      */
     suspend fun getEntryComments(entryID: Long, sorting: SortingType): List<Comment>
 
     /**
-     * Получить комментарии к записи с ограничением по веткам
+     * Get comments of the record with thread level restriction
      */
     suspend fun getLevelComments(entryID: Long, sorting: SortingType): CommentsLevelLimited
 
     /**
-     * Получить комментарии к записи с ограничением по веткам
+     * Get comments of the record with thread restriction
      */
     suspend fun getThreadComments(entryID: Long, commentID: Long): List<Comment>
 
     /**
-     * Получить список лайкнувших комментарий
+     * Get a list of people who liked the comment
      */
     suspend fun getCommentVotes(commentID: Long): Map<String, Liker>
 }
@@ -40,7 +40,7 @@ interface IPublicCommentAPI {
  */
 interface IAuthCommentAPI: IPublicCommentAPI, Authable {
     /**
-     * Отправить количество увиденных комментариев
+     * Send the number of comments seen
      */
     suspend fun postSeenComments(entryID: Long, count: Long)
 }
\ No newline at end of file
diff --git a/src/main/kotlin/kmtt/api/user/IPublicUserAPI.kt b/src/main/kotlin/kmtt/api/user/IPublicUserAPI.kt
index 5d0c89a8..9464d664 100644
--- a/src/main/kotlin/kmtt/api/user/IPublicUserAPI.kt
+++ b/src/main/kotlin/kmtt/api/user/IPublicUserAPI.kt
@@ -8,31 +8,35 @@ import kmtt.models.subsite.Subsite
 
 interface IPublicUserAPI {
     /**
-     * Получить информацию о пользователе
+     * Get user information by ID
      */
     suspend fun getUserByID(userID: Long): Subsite
 
     /**
-     * Получить комментарии пользователя
+     * Get user comments
      *
      * Max count: 50
      */
     suspend fun getUserComments(userID: Long, count: Int, offset: Int): List<Comment>
 
     /**
-     * Получить все комментарии пользователя
+     * Get all user comments.
+     *
+     * If user has a lot of comments, it could take a long time to get all of them
      */
     suspend fun getAllUserComments(userID: Long): List<Comment>
 
     /**
-     * Получить записи пользователя
+     * Get user entries
      *
      * Max count: 50
      */
     suspend fun getUserEntries(userID: Long, count: Int, offset: Int): List<Entry>
 
     /**
-     * Получить записи пользователя
+     * Get all user entries.
+     *
+     * If user has a lot of entries, it could take a long time to get all of them
      */
     suspend fun getAllUserEntries(userID: Long): List<Entry>
 }
@@ -40,75 +44,83 @@ interface IPublicUserAPI {
 interface IAuthUserAPI : IPublicUserAPI, Authable {
 
     /**
-     * Получить информацию о текущем пользователе
+     * Get information about the current user
      */
     suspend fun getMe(): Subsite
 
     /**
-     * Получить список уведомлений
+     * Get notification list for the current user
      */
     suspend fun getMyNotifications(): List<Notification>
 
     /**
-     * Получить количество непрочитанных уведомлений у текущего пользователя
+     * Get the number of unread notifications for the current user
      */
     suspend fun getMyNotificationsCount(): Int
 
     /**
-     * Сделать уведомление прочитанным
+     * Mark the notification as read
      */
     suspend fun readNotificationsById(id: Long): Boolean
 
     /**
-     * Сделать уведомления прочитанными
+     * Mark all notifications as read
      */
     suspend fun readAllNotifications(): List<Notification>
 
     /**
-     * Получить комментарии текущего пользователя
+     * Get the current user's comments
      *
      * Max count: 50
      */
     suspend fun getMyComments(count: Int, offset: Int): List<Comment>
 
     /**
-     * Получить все комментарии текущего пользователя
+     * Get all comments of the current user.
+     *
+     * If user has a lot of comments, it could take a long time to get all of them
      */
     suspend fun getAllMyComments(): List<Comment>
 
     /**
-     * Получить записи текущего пользователя
+     * Get entries of the current user
      *
      * Max count: 50
      */
     suspend fun getMyEntries(count: Int, offset: Int): List<Entry>
 
     /**
-     * Получить все записи текущего пользователя
+     * Get all entries of the current user.
+     *
+     * If user has a lot of entries, it could take a long time to get all of them
      */
     suspend fun getAllMyEntries(): List<Entry>
 
     /**
-     * Получить избранные записи текущего пользователя
+     * Get the current user's favorites
      *
      * Max count: 50
      */
     suspend fun getMyFavoriteEntries(count: Int, offset: Int): List<Entry>
 
     /**
-     * Получить все избранные записи текущего пользователя
+     * Get all favorites of the current user.
+     *
+     * If user has a lot of entries, it could take a long time to get all of them
      */
     suspend fun getAllMyFavoriteEntries(): List<Entry>
 
     /**
-     * Получить избранные комментарии текущего пользователя
+     * Get the current user's favorite comments.
      *
      * Max count: 50
      */
     suspend fun getMyFavoriteComments(count: Int, offset: Int): List<Comment>
 
     /**
-     * Получить все избранные комментарии текущего пользователя
+     * Get all the current user's favorite comments.
+     *
+     * If user has a lot of entries, it could take a long time to get all of them
      */
     suspend fun getAllMyFavoriteComments(): List<Comment>
 }
\ No newline at end of file