doc(api): dokkaを導入。足りていない説明を追記

Author: sya-ri

api/build.gradle.kts

@@ -1,10 +1,16 @@
 import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+import org.jetbrains.dokka.gradle.DokkaTask
 
 plugins {
+    id("org.jetbrains.dokka") version "1.4.20"
     `maven-publish`
     signing
 }
 
+repositories {
+    jcenter()
+}
+
 group = "com.github.sya-ri.spigot.api"
 version = "1.0.1"
 

api/src/main/kotlin/com/github/syari/spigot/api/EasySpigotAPI.kt

@@ -3,6 +3,7 @@ package com.github.syari.spigot.api
 import org.bukkit.plugin.java.JavaPlugin
 
 /**
+ * メインクラス
  * @since 1.0.0
  */
 @Suppress("unused")

api/src/main/kotlin/com/github/syari/spigot/api/event/register/EventRegister.kt

@@ -3,18 +3,22 @@ package com.github.syari.spigot.api.event.register
 import org.bukkit.plugin.java.JavaPlugin
 
 /**
+ * 継承することでイベントの登録を行える。
  * @since 1.0.0
  */
 interface EventRegister {
     /**
-     * この関数内でイベントの登録をする
+     * この関数内でイベントの登録をする。
      * @since 1.0.0
      */
     fun Events.register()
 
+    /**
+     * @see EventRegister.registerEvents
+     */
     companion object {
         /**
-         * [JavaPlugin.onEnable] 内で呼び出すことでイベントの登録をする
+         * [JavaPlugin.onEnable] 内で呼び出すことでイベントの登録をする。
          * ```
          * override fun onEnable() {
          *     registerEvents(...)

api/src/main/kotlin/com/github/syari/spigot/api/event/register/Events.kt

@@ -7,11 +7,12 @@ import org.bukkit.event.Listener
 import org.bukkit.plugin.java.JavaPlugin
 
 /**
+ * [EventRegister.register] で使われている。イベントの定義を行える。
  * @since 1.0.0
  */
 class Events internal constructor(val plugin: JavaPlugin) : Listener {
     /**
-     * イベントを定義する
+     * イベントを定義する。
      * @since 1.0.0
      */
     inline fun <reified T : Event> event(
@@ -32,7 +33,7 @@ class Events internal constructor(val plugin: JavaPlugin) : Listener {
     }
 
     /**
-     * 条件に一致した時に特定のイベントをキャンセルする
+     * 条件に一致した時に特定のイベントをキャンセルする。
      * @since 1.0.0
      */
     inline fun <reified T> cancelEventIf(
@@ -45,7 +46,7 @@ class Events internal constructor(val plugin: JavaPlugin) : Listener {
     }
 
     /**
-     * 条件に一致しなかった時に特定のイベントをキャンセルする
+     * 条件に一致しなかった時に特定のイベントをキャンセルする。
      * @since 1.0.0
      */
     inline fun <reified T> cancelEventIfNot(

api/src/main/kotlin/com/github/syari/spigot/api/util/uuid/UUIDEntity.kt

@@ -5,41 +5,44 @@ import org.bukkit.entity.Entity
 import java.util.UUID
 
 /**
- * [Entity] が持つ [UUID] を操作しやすくしたクラス
+ * [Entity] が持つ [UUID] を操作しやすくしたクラス。
  *
- * 変数に保存する際には [Entity] ではなく [UUID] で保存することを推奨する
+ * 変数に保存する際には [Entity] ではなく [UUID] で保存することを推奨する。
  * @since 1.1.0
  */
 data class UUIDEntity(val uniqueId: UUID) : Comparable<UUIDEntity> {
     /**
-     * [Entity] として取得する
+     * [Entity] として取得する。
      * @since 1.1.0
      */
     val entity: Entity?
         get() = Bukkit.getEntity(uniqueId)
 
     /**
-     * [UUIDEntity.uniqueId] を文字列として取得する
+     * [UUIDEntity.uniqueId] を文字列として取得する。
      * @see [UUID.toString]
      * @since 1.1.0
      */
     override fun toString() = uniqueId.toString()
 
     /**
-     * [UUIDEntity.uniqueId] を比較する
+     * [UUIDEntity.uniqueId] を比較する。
      * @see [UUID.compareTo]
      * @since 1.1.0
      */
     override fun compareTo(other: UUIDEntity) = uniqueId.compareTo(other.uniqueId)
 
+    /**
+     * @see UUIDEntity.from
+     */
     companion object {
         /**
-         * [Entity] を [UUIDEntity] に変換する
+         * [Entity] を [UUIDEntity] に変換する。
          */
         fun from(entity: Entity) = UUIDEntity(entity.uniqueId)
 
         /**
-         * [UUID] を表す文字列から [UUIDEntity] に変換する
+         * [UUID] を表す文字列から [UUIDEntity] に変換する。
          */
         fun from(uniqueId: String) = uuidOrNull(uniqueId)?.let(::UUIDEntity)
     }

api/src/main/kotlin/com/github/syari/spigot/api/util/uuid/UUIDPlayer.kt

@@ -6,48 +6,51 @@ import org.bukkit.entity.Player
 import java.util.UUID
 
 /**
- * [Player] が持つ [UUID] を操作しやすくしたクラス
+ * [Player] が持つ [UUID] を操作しやすくしたクラス。
  *
- * 変数に保存する際には [Player] や [OfflinePlayer] ではなく [UUID] で保存することを推奨する
+ * 変数に保存する際には [Player] や [OfflinePlayer] ではなく [UUID] で保存することを推奨する。
  * @since 1.1.0
  */
 data class UUIDPlayer(val uniqueId: UUID) : Comparable<UUIDPlayer> {
     /**
-     * [Player] として取得する
+     * [Player] として取得する。
      * @since 1.1.0
      */
     val player: Player?
         get() = Bukkit.getPlayer(uniqueId)
 
     /**
-     * [OfflinePlayer] として取得する
+     * [OfflinePlayer] として取得する。
      * @since 1.1.0
      */
     val offlinePlayer: OfflinePlayer
         get() = Bukkit.getOfflinePlayer(uniqueId)
 
     /**
-     * [UUIDPlayer.uniqueId] を文字列として取得する
+     * [UUIDPlayer.uniqueId] を文字列として取得する。
      * @see [UUID.toString]
      * @since 1.1.0
      */
     override fun toString() = uniqueId.toString()
 
     /**
-     * [UUIDPlayer.uniqueId] を比較する
+     * [UUIDPlayer.uniqueId] を比較する。
      * @see [UUID.compareTo]
      * @since 1.1.0
      */
     override fun compareTo(other: UUIDPlayer) = uniqueId.compareTo(other.uniqueId)
 
+    /**
+     * @see UUIDPlayer.from
+     */
     companion object {
         /**
-         * [OfflinePlayer] を [UUIDPlayer] に変換する
+         * [OfflinePlayer] を [UUIDPlayer] に変換する。
          */
         fun from(player: OfflinePlayer) = UUIDPlayer(player.uniqueId)
 
         /**
-         * [UUID] を表す文字列から [UUIDPlayer] に変換する
+         * [UUID] を表す文字列から [UUIDPlayer] に変換する。
          */
         fun from(uniqueId: String) = uuidOrNull(uniqueId)?.let(::UUIDPlayer)
     }

api/src/main/kotlin/com/github/syari/spigot/api/util/uuid/extension.kt

@@ -3,13 +3,13 @@ package com.github.syari.spigot.api.util.uuid
 import java.util.UUID
 
 /**
- * [UUID.fromString] を実行する
+ * [UUID.fromString] を実行する。
  * @since 1.1.0
  */
 fun uuid(name: String): UUID = UUID.fromString(name)
 
 /**
- * [uuid] を実行するが、例外が発生した場合は null を返す
+ * [uuid] を実行するが、例外が発生した場合は null を返す。
  * @since 1.1.0
  */
 fun uuidOrNull(name: String): UUID? = try {