Add kdoc

src/main/kotlin/top/fatweb/api/annotation/ApiController.kt

@@ -5,6 +5,15 @@ import org.springframework.core.annotation.AliasFor
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RestController
 
+/**
+ * API controller annotation
+ *
+ * @author FatttSnake, fatttsnake@gmail.com
+ * @since 1.0.0
+ * @see Tag
+ * @see RequestMapping
+ * @see RestController
+ */
 @Tag(name = "")
 @RequestMapping
 @RestController

src/main/kotlin/top/fatweb/api/annotation/BaseController.kt

@@ -5,6 +5,14 @@ import org.springframework.core.annotation.AliasFor
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RestController
 
+/**
+ * Base controller annotation
+ *
+ * @author FatttSnake, fatttsnake@gmail.com
+ * @since 1.0.0
+ * @see RequestMapping
+ * @see RestController
+ */
 @Tag(name = "")
 @RequestMapping
 @RestController

src/main/kotlin/top/fatweb/api/annotation/EventLogRecord.kt

@@ -2,6 +2,12 @@ package top.fatweb.api.annotation
 
 import top.fatweb.api.entity.system.EventLog
 
+/**
+ * Event log record annotation
+ *
+ * @author FatttSnake, fatttsnake@gmail.com
+ * @since 1.0.0
+ */
 @Target(AnnotationTarget.FUNCTION)
 @Retention(AnnotationRetention.RUNTIME)
 annotation class EventLogRecord(

src/main/kotlin/top/fatweb/api/annotation/HiddenController.kt

@@ -5,6 +5,15 @@ import org.springframework.core.annotation.AliasFor
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RestController
 
+/**
+ * Hidden controller annotation
+ *
+ * @author FatttSnake, fatttsnake@gmail.com
+ * @since 1.0.0
+ * @see Hidden
+ * @see RequestMapping
+ * @see RestController
+ */
 @Hidden
 @RequestMapping
 @RestController

src/main/kotlin/top/fatweb/api/aop/EventLogAspect.kt

@@ -13,6 +13,12 @@ import top.fatweb.api.entity.system.EventLog
 import top.fatweb.api.service.system.IEventLogService
 import top.fatweb.api.util.WebUtil
 
+/**
+ * Event log record aspect
+ *
+ * @author FatttSnake, fatttsnake@gmail.com
+ * @since 1.0.0
+ */
 @Aspect
 @Component
 class EventLogAspect(

src/main/kotlin/top/fatweb/api/config/WebMvcConfigurerConfig.kt

@@ -1,10 +1,18 @@
 package top.fatweb.api.config
 
+import org.springframework.boot.autoconfigure.web.servlet.WebMvcRegistrations
 import org.springframework.context.annotation.Configuration
 import org.springframework.web.servlet.config.annotation.PathMatchConfigurer
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer
 import top.fatweb.api.annotation.ApiController
 
+/**
+ * Web MVC configurer configuration
+ *
+ * @author FatttSnake, fatttsnake@gmail.com
+ * @since 1.0.0
+ * @see WebMvcRegistrations
+ */
 @Configuration
 class WebMvcConfigurerConfig : WebMvcConfigurer {
     override fun configurePathMatch(configurer: PathMatchConfigurer) {

src/main/kotlin/top/fatweb/api/config/WebMvcRegistrationsConfig.kt

@@ -6,7 +6,7 @@ import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandl
 import top.fatweb.api.util.ApiResponseMappingHandlerMapping
 
 /**
- * Web MVC configuration
+ * Web MVC registrations configuration
  *
  * @author FatttSnake, fatttsnake@gmail.com
  * @since 1.0.0

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
     )
 }