Document all classes in the 'model' package

Author: mrapplexz

src/commonMain/kotlin/net/pearx/kpastebin/model/AccountType.kt

@@ -1,7 +1,12 @@
 package net.pearx.kpastebin.model
 
-public enum class AccountType
-{
+/**
+ * The list of Pastebin account types
+ */
+public enum class AccountType {
+    /** Free basic account */
     NORMAL,
+
+    /** Paid pro account */
     PRO;
 }

src/commonMain/kotlin/net/pearx/kpastebin/model/ExpireDate.kt

@@ -1,14 +1,34 @@
 package net.pearx.kpastebin.model
 
+/**
+ * The list of possible Pastebin paste expire durations
+ */
 public enum class ExpireDate(internal val code: String) {
+    /** Paste will never expire */
     NEVER("N"),
+
+    /** Paste will expire in 10 minutes after publication */
     TEN_MINUTES("10M"),
+
+    /** Paste will expire in a hour after publication */
     ONE_HOUR("1H"),
+
+    /** Paste will expire in a day after publication */
     ONE_DAY("1D"),
+
+    /** Paste will expire in a week after publication */
     ONE_WEEK("1W"),
+
+    /** Paste will expire in two weeks after publication */
     TWO_WEEEKS("2W"),
+
+    /** Paste will expire in a month after publication */
     ONE_MONTH("1M"),
+
+    /** Paste will expire in six months after publication */
     SIX_MONTHS("6M"),
+
+    /** Paste will expire in a year after publication */
     ONE_YEAR("1Y");
 
     internal companion object {

src/commonMain/kotlin/net/pearx/kpastebin/model/PasteDetails.kt

@@ -3,17 +3,30 @@ package net.pearx.kpastebin.model
 import net.pearx.kpastebin.internal.XML_PARENT_REGEX
 import net.pearx.kpastebin.internal.XML_PROPERTY_REGEX
 
+/**
+ * A detailed Pastebin paste information
+ */
 public data class PasteDetails(
+    /** Paste key */
     val key: String,
+    /** Paste publication date */
     val date: Int,
+    /** Paste title */
     val title: String,
+    /** Paste size in bytes */
     val size: Int,
+    /** Paste expiration date */ // todo
     val expireDate: Int,
+    /** Paste privacy status */
     val privacy: Privacy,
+    /** Paste syntax highlighting language in a user-readable format (e.g., Kotlin or C#) */
     val formatLong: String,
+    /** Paste syntax highlighting language in a short format (e.g. kotlin or csharp) */
     val formatShort: String,
+    /** Paste URL */
     val url: String,
-    val hist: Int
+    /** Paste views count */
+    val hits: Int
 ) {
     internal companion object {
         fun parseList(input: String): List<PasteDetails> {

src/commonMain/kotlin/net/pearx/kpastebin/model/Privacy.kt

@@ -1,7 +1,15 @@
 package net.pearx.kpastebin.model
 
+/**
+ * The list of possible Pastebin paste privacy states
+ */
 public enum class Privacy {
+    /** Paste is visible for all users */
     PUBLIC,
+
+    /** Paste is invisible for others unless you share your paste link */
     UNLISTED,
+
+    /** Paste is visible only for you */
     PRIVATE;
 }

src/commonMain/kotlin/net/pearx/kpastebin/model/UserDetails.kt

@@ -3,15 +3,27 @@ package net.pearx.kpastebin.model
 import net.pearx.kpastebin.internal.XML_PARENT_REGEX
 import net.pearx.kpastebin.internal.XML_PROPERTY_REGEX
 
+/**
+ * A detailed Pastebin user information
+ */
 public data class UserDetails(
+    /** Full user name */
     val name: String,
+    /** Default paste syntax highlighting language for this user in a short format (e.g., kotlin or csharp) */
     val defaultFormatShort: String,
+    /** Default paste expiration duration for this user */
     val defaultExpiration: ExpireDate,
+    /** User avatar URL */
     val avatarUrl: String,
+    /** Default paste privacy status for this user */
     val defaultPrivacy: Privacy,
+    /** User website */
     val website: String,
+    /** User E-Mail */
     val email: String,
+    /** User location */
     val location: String,
+    /** User account type */
     val accountType: AccountType
 ) {
     internal companion object {