Add kdoc

2023-12-18 18:28:38 +08:00
parent 0f5d1fad4b
commit aa4d70ce99
8 changed files with 81 additions and 1 deletions
--- a/src/main/kotlin/top/fatweb/api/vo/system/OnlineInfoVo.kt
+++ b/src/main/kotlin/top/fatweb/api/vo/system/OnlineInfoVo.kt
@@ -2,12 +2,46 @@ package top.fatweb.api.vo.system

 import java.time.LocalDateTime

+/**
+ * Online information value object
+ *
+ * @author FatttSnake, fatttsnake@gmail.com
+ * @since 1.0.0
+ */
 data class OnlineInfoVo(
+    /**
+     * Number of user currently online
+     *
+     * @author FatttSnake, fatttsnake@gmail.com
+     * @since 1.0.0
+     */
    val current: Long,
+
+    /**
+     * Online number history
+     *
+     * @author FatttSnake, fatttsnake@gmail.com
+     * @since 1.0.0
+     * @see HistoryVo
+     */
    val history: List<HistoryVo>
 ) {
    data class HistoryVo (
+        /**
+         * Time
+         *
+         * @author FatttSnake, fatttsnake@gmail.com
+         * @since 1.0.0
+         * @see LocalDateTime
+         */
        val time: LocalDateTime,
+
+        /**
+         * Record
+         *
+         * @author FatttSnake, fatttsnake@gmail.com
+         * @since 1.0.0
+         */
        val record: String
    )
 }