fix KDoc typos

Author: CJCrafter

src/main/kotlin/com/cjcrafter/openai/chat/ChatChoice.kt

@@ -13,15 +13,16 @@ import com.google.gson.JsonObject
  * generate, the more tokens you use. In general, it is best to **ONLY**
  * generate 1 response, and to let the user regenerate the response.
  *
- * @param index        The index in the array... 0 if [ChatRequest.n]=1.
- * @param message      The generated text.
- * @param finishReason Why did the bot stop generating tokens?
+ * @property index        The index in the array... 0 if [ChatRequest.n]=1.
+ * @property message      The generated text.
+ * @property finishReason Why did the bot stop generating tokens?
+ * @constructor Create a new chat choice, for internal usage.
  * @see FinishReason
  */
 class ChatChoice(val index: Int, val message: ChatMessage, val finishReason: FinishReason?) {
 
     /**
-     * JSON constructor for internal use.
+     * JSON constructor for internal usage.
      */
     constructor(json: JsonObject) : this(
         json["index"].asInt,

src/main/kotlin/com/cjcrafter/openai/chat/ChatMessage.kt

@@ -6,6 +6,10 @@ import com.google.gson.JsonObject
  * ChatGPT's biggest innovation is its conversation memory. To remember the
  * conversation, we need to map each message to who sent it. This data class
  * wraps a message with the user who sent the message.
+ *
+ * @property role The user who sent this message.
+ * @property content The string content of the message.
+ * @see ChatUser
  */
 data class ChatMessage(val role: ChatUser, val content: String) {
 

src/main/kotlin/com/cjcrafter/openai/chat/ChatRequest.kt

@@ -33,7 +33,7 @@ import com.google.gson.annotations.SerializedName
  * @property presencePenalty  Prevent talking about duplicate topics. Defaults to `0.0`.
  * @property frequencyPenalty Prevent repeating the same text. Defaults to `0.0`.
  * @property logitBias        Increase/Decrease the chances of a specific token to appear in generated text. Defaults to `null`.
- * @property user             Who send this request (for moderation).
+ * @property user             Who sent this request (for moderation).
  * @constructor Create a chat request
  * @see ChatBot.generateResponse
  * @see <a href="https://platform.openai.com/docs/api-reference/completions/create">OpenAI Wiki</a>

src/main/kotlin/com/cjcrafter/openai/chat/ChatResponse.kt

@@ -3,8 +3,16 @@ package com.cjcrafter.openai.chat
 import com.google.gson.JsonObject
 
 /**
- * This is the object returned from the API. You want to access choices[0]
- * to get your response.
+ * The [ChatResponse] contains all the data returned by the OpenAI Chat API.
+ * For most use cases, [ChatResponse.get] (passing 0 to the index argument) is
+ * all you need.
+ *
+ * @property id
+ * @property object
+ * @property created
+ * @property choices
+ * @property usage
+ * @constructor Create empty Chat response
  */
 class ChatResponse(
     val id: String,