From fedff77338f7d6c5a30ec990896bef937599f6a7 Mon Sep 17 00:00:00 2001
From: alphaBEE <61616007+ankitsmt211@users.noreply.github.com>
Date: Wed, 28 Feb 2024 04:58:12 +0530
Subject: [PATCH] add doc for param to fix sonar issue

---
 .../org/togetherjava/tjbot/features/chatgpt/ChatGptService.java | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/application/src/main/java/org/togetherjava/tjbot/features/chatgpt/ChatGptService.java b/application/src/main/java/org/togetherjava/tjbot/features/chatgpt/ChatGptService.java
index db91b64f64..a145b42139 100644
--- a/application/src/main/java/org/togetherjava/tjbot/features/chatgpt/ChatGptService.java
+++ b/application/src/main/java/org/togetherjava/tjbot/features/chatgpt/ChatGptService.java
@@ -85,6 +85,8 @@ public ChatGptService(Config config) {
      * Prompt ChatGPT with a question and receive a response.
      *
      * @param question The question being asked of ChatGPT. Max is {@value MAX_TOKENS} tokens.
+     * @param context The category of asked question, to set the context(eg. Java, Database, Other
+     *        etc).
      * @return partitioned response from ChatGPT as a String array.
      * @see <a href="https://platform.openai.com/docs/guides/chat/managing-tokens">ChatGPT
      *      Tokens</a>.