add doc for param to fix sonar issue (#1036)

ankitsmt211 · web-flow · commit 3388c6d773c0 · 2024-02-29T20:24:05.000+01:00
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
@@ -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>.

Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,8 @@ public ChatGptService(Config config) {`
`85`	`85`	`* Prompt ChatGPT with a question and receive a response.`
`86`	`86`	`*`
`87`	`87`	`* @param question The question being asked of ChatGPT. Max is {@value MAX_TOKENS} tokens.`
	`88`	`+ * @param context The category of asked question, to set the context(eg. Java, Database, Other`
	`89`	`+ * etc).`
`88`	`90`	`* @return partitioned response from ChatGPT as a String array.`
`89`	`91`	`* @see <a href="https://platform.openai.com/docs/guides/chat/managing-tokens">ChatGPT`
`90`	`92`	`* Tokens</a>.`