Update KDoc

kordlib · Sep 18, 2023 · e1f8d7a · e1f8d7a
1 parent 434bd27
commit e1f8d7a
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/common/src/commonMain/kotlin/entity/DiscordApplication.kt b/common/src/commonMain/kotlin/entity/DiscordApplication.kt
@@ -133,7 +133,7 @@ public data class DiscordApplication(
 /**
  * A representation of the partial
  * [Application Structure](https://discord.com/developers/docs/resources/application#application-object-application-structure)
- * sent in [invite create events](https://discord.com/developers/docs/topics/gateway#invite-create).
+ * sent in [invite create events](https://discord.com/developers/docs/topics/gateway-events#invite-create).
  */
 @Serializable
 public data class DiscordPartialApplication(

diff --git a/gateway/src/commonMain/kotlin/Command.kt b/gateway/src/commonMain/kotlin/Command.kt
@@ -125,7 +125,7 @@ public data class Resume(
 
 /**
  * A representation of the
- * [Discord Request Guild Members command](https://discord.com/developers/docs/topics/gateway#request-guild-members).
+ * [Discord Request Guild Members command](https://discord.com/developers/docs/topics/gateway-events#request-guild-members).
  *
  * When connecting to a [Gateway] Discord will send members up to [Identify.largeThreshold], any additional
  * members can be requested via this command. Sending this command will result in a variable amount of

diff --git a/gateway/src/commonMain/kotlin/DefaultGateway.kt b/gateway/src/commonMain/kotlin/DefaultGateway.kt
@@ -112,7 +112,7 @@ public class DefaultGateway(private val data: DefaultGatewayData) : Gateway {
                 defaultGatewayLogger.trace { "opening gateway connection to $gatewayUrl" }
                 socket = data.client.webSocketSession { url(gatewayUrl) }
 
-                /**
+                /*
                  * https://discord.com/developers/docs/topics/gateway#transport-compression
                  *
                  * > Every connection to the gateway should use its own unique zlib context.

diff --git a/gateway/src/commonMain/kotlin/Gateway.kt b/gateway/src/commonMain/kotlin/Gateway.kt
@@ -18,15 +18,15 @@ import kotlin.time.Duration
 /**
  * An implementation of the Discord [Gateway](https://discord.com/developers/docs/topics/gateway) and its lifecycle.
  *
- * Allows consumers to receive [events](https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-events)
- * through [events] and send [commands](https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-commands)
+ * Allows consumers to receive [events](https://discord.com/developers/docs/topics/gateway-events#receive-events)
+ * through [events] and send [commands](https://discord.com/developers/docs/topics/gateway-events#send-events)
  * through [send].
  */
 public interface Gateway : CoroutineScope {
     /**
-     * The incoming [events](https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-events)
-     * of the Gateway. Users should expect these [Flows](Flow) to be hot and remain open for the entire lifecycle of the
-     * Gateway.
+     * The incoming [events](https://discord.com/developers/docs/topics/gateway-events) of the Gateway.
+     *
+     * Users should expect these [Flows](Flow) to be hot and remain open for the entire lifecycle of the Gateway.
      */
     public val events: SharedFlow<Event>
 

diff --git a/rest/src/commonMain/kotlin/json/JsonErrorCode.kt b/rest/src/commonMain/kotlin/json/JsonErrorCode.kt
@@ -235,10 +235,10 @@ public enum class JsonErrorCode(public val code: Int) {
     /** Maximum number of application commands reached. */
     MaxApplicationCommands(30032),
 
-    /** Max number of thread participants has been reached (1000). */
+    /** Maximum number of thread participants has been reached (1000). */
     MaxThreadParticipants(30033),
 
-    /** Max number of daily application command creates has been reached (200). */
+    /** Maximum number of daily application command creates has been reached (200). */
     MaxDailyApplicationCommandCreates(30034),
 
     /** Maximum number of bans for non-guild members have been exceeded. */