From 7787dd1ecc29f9640594d295bb3fa9dbfb66cf69 Mon Sep 17 00:00:00 2001
From: Aria Moradi <aria.moradi007@gmail.com>
Date: Sat, 7 Aug 2021 22:18:05 +0430
Subject: [PATCH] better comments

---
 .../suwayomi/tachidesk/manga/MangaAPI.kt      |  4 ++--
 .../manga/model/table/ChapterMetaTable.kt     | 22 +++++++++++++++++++
 .../manga/model/table/MangaMetaTable.kt       | 22 +++++++++++++++++++
 3 files changed, 46 insertions(+), 2 deletions(-)

diff --git a/server/src/main/kotlin/suwayomi/tachidesk/manga/MangaAPI.kt b/server/src/main/kotlin/suwayomi/tachidesk/manga/MangaAPI.kt
index d58b25ea..6d5ed5cf 100644
--- a/server/src/main/kotlin/suwayomi/tachidesk/manga/MangaAPI.kt
+++ b/server/src/main/kotlin/suwayomi/tachidesk/manga/MangaAPI.kt
@@ -202,7 +202,7 @@ object MangaAPI {
             ctx.json(future { getChapterList(mangaId, onlineFetch) })
         }
 
-        // used to modify a manga's meta paramaters
+        // used to modify a manga's meta parameters
         app.patch("/api/v1/manga/:mangaId/meta") { ctx ->
             val mangaId = ctx.pathParam("mangaId").toInt()
 
@@ -236,7 +236,7 @@ object MangaAPI {
             ctx.status(200)
         }
 
-        // used to modify a chapter's meta paramaters
+        // used to modify a chapter's meta parameters
         app.patch("/api/v1/manga/:mangaId/chapter/:chapterIndex/meta") { ctx ->
             val chapterIndex = ctx.pathParam("chapterIndex").toInt()
             val mangaId = ctx.pathParam("mangaId").toInt()
diff --git a/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/ChapterMetaTable.kt b/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/ChapterMetaTable.kt
index 223b2021..b290e8ff 100644
--- a/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/ChapterMetaTable.kt
+++ b/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/ChapterMetaTable.kt
@@ -1,8 +1,30 @@
 package suwayomi.tachidesk.manga.model.table
 
+/*
+ * Copyright (C) Contributors to the Suwayomi project
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+
 import org.jetbrains.exposed.dao.id.IntIdTable
 import org.jetbrains.exposed.sql.ReferenceOption
+import suwayomi.tachidesk.manga.model.table.ChapterMetaTable.ref
 
+/**
+ * Meta data storage for clients, about Chapter with id == [ref].
+ *
+ *  For example, if you added reader mode(with the key juiReaderMode) such as webtoon to a manga object,
+ *  this is what will show up when you request that manga from the api again
+ *
+ * {
+ *   "id": 10,
+ *   "title": "Isekai manga",
+ *   "meta": {
+ *     "juiReaderMode": "webtoon"
+ *   }
+ * }
+ */
 object ChapterMetaTable : IntIdTable() {
     val key = varchar("key", 256)
     val value = varchar("value", 4096)
diff --git a/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/MangaMetaTable.kt b/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/MangaMetaTable.kt
index 1e834869..ed661e33 100644
--- a/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/MangaMetaTable.kt
+++ b/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/MangaMetaTable.kt
@@ -1,8 +1,30 @@
 package suwayomi.tachidesk.manga.model.table
 
+/*
+ * Copyright (C) Contributors to the Suwayomi project
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+
 import org.jetbrains.exposed.dao.id.IntIdTable
 import org.jetbrains.exposed.sql.ReferenceOption
+import suwayomi.tachidesk.manga.model.table.MangaMetaTable.ref
 
+/**
+ * Meta data storage for clients, about Manga with id == [ref].
+ *
+ *  For example, if you added reader mode(with the key juiReaderMode) such as webtoon to a manga object,
+ *  this is what will show up when you request that manga from the api again
+ *
+ * {
+ *   "id": 10,
+ *   "title": "Isekai manga",
+ *   "meta": {
+ *     "juiReaderMode": "webtoon"
+ *   }
+ * }
+ */
 object MangaMetaTable : IntIdTable() {
     val key = varchar("key", 256)
     val value = varchar("value", 4096)